Get a participant group

AuthorizationToken

Header authentication of the form Token <token>

idstringRequired

The id of the participant group

Request successful.

descriptionstring or null

The user-provided description of the participant group

feeder_studieslist of objects or nullRead-only

Details of all studies which are configured to modify the participants in this group through completion codes.

idstring or null

The id of the participant group

is_deletedboolean or nullRead-only

Whether the participant group has been deleted

namestring or null

The name of the participant group

organisation_idstring or null

The id of the organisation the participant group belongs to. A participant group can only belong to either a workspace or an organisation.

participant_countinteger or nullRead-only

The number of participants in the participant group

workspace_idstring or null

The id of the workspace the participant group belongs to. A participant group can only belong to either a workspace or an organisation.

project_idstring or nullDeprecated

The id of the project the participant group belongs to

1	{
2	"description": "My first participant group",
3	"feeder_studies": [
4	{
5	"id": "5e9b9c9b0f9c9a0001b0b1f4",
6	"name": "Study 1",
7	"internal_name": "My Study",
8	"status": "COMPLETED",
9	"feeder_completion_codes": [
10	{
11	"code": "AJVRH234",
12	"code_type": "COMPLETION_CODE",
13	"action": "ADD_TO_PARTICIPANT_GROUP"
14	}
15	]
16	}
17	],
18	"id": "5e9b9c9b0f9c9a0001b0b1f5",
19	"is_deleted": false,
20	"name": "Group 1",
21	"organisation_id": "5e9b9c9b0f9c9a0001b1ca2f",
22	"participant_count": 10,
23	"workspace_id": "5e9b9c9b0f9c9a0001b1ca2f",
24	"project_id": null
25	}

1	curl https://api.prolific.com/api/v1/participant-groups/id/ \
2	-H "Authorization: Token <token>"