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

GET

https://api.prolific.com/api/v1/participant-groups/

GET

/api/v1/participant-groups/

1 import requests
2 
3 url = "https://api.prolific.com/api/v1/participant-groups/"
4 
5 querystring = {"filter":"{\"workspace_id\":\"string\"}"}
6 
7 headers = {"Authorization": "Token <token>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

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 }

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

activeenumOptional

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

Allowed values:

filterobjectRequired

Response

Request successful.

resultslist of objects or null

Authentication

Query parameters

Response

Errors