Get a list of all participant groups within a project or workspace

curl -G https://api.prolific.com/api/v1/participant-groups/ \
     -H "Authorization: Token <token>" \
     -d "filter[workspace_id]=string"

{
  "results": [
    {
      "id": "5e9b9c9b0f9c9a0001b0b1f5",
      "name": "Group 1",
      "workspace_id": "5e9b9c9b0f9c9a0001b1ca2f",
      "organisation_id": "5e9b9c9b0f9c9a0001b1ca2f",
      "description": "My first participant group",
      "participant_count": 10,
      "is_deleted": false,
      "feeder_studies": [
        {
          "id": "5e9b9c9b0f9c9a0001b0b1f4",
          "name": "Study 1",
          "internal_name": "My Study",
          "status": "COMPLETED",
          "feeder_completion_codes": [
            {
              "code": "AJVRH234",
              "code_type": "COMPLETION_CODE",
              "action": "ADD_TO_PARTICIPANT_GROUP"
            }
          ]
        }
      ],
      "project_id": null
    }
  ]
}

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Query parameters

activeenumOptional

Filter by the active (not deleted) status of the participant group.

Allowed values:

filterobjectRequired

Response

Request successful.

resultslist of objects

Errors

4XX

Client Request Error

$	curl -G https://api.prolific.com/api/v1/participant-groups/ \
>	-H "Authorization: Token <token>" \
>	-d "filter[workspace_id]=string"

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