Count participants | Prolific API

Count how many participants meet all the given filters. Only participants that pass every one of the filters are counted. Zero means that there are less than 25 participants. We do not show lower numbers to protect the privacy of the participants.

To see a list of filters that may be passed to this endpoint, see the documentation for filters.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Request

This endpoint expects an object.

filterslist of objectsRequired

List of filters to apply to the count. This parameter uses the new, simplified filters schema for interacting with eligibility.

workspace_idstringOptional

The ID of the workspace you will be creating a study in. Due to US tax laws, non US residents may not participate in studies created by US researchers. For this reason, we use the country specified in the workspace to determine eligibility. If you do not specify a workspace ID, we will use the current workspace ID of the user making the request. Your eligibility count may not be accurate if you do not specify a workspace ID.

organisation_idstringOptional

The ID of the workspace you will be creating a filterset in.

Response

Count

countdouble

Number of participants passing all the requirements

1	curl -X POST https://api.prolific.com/api/v1/eligibility-count/ \
2	-H "Authorization: Token <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"filters": [
6	{
7	"field": "age",
8	"operator": "gte",
9	"value": 18
10	},
11	{
12	"field": "enrollment_status",
13	"operator": "eq",
14	"value": "active"
15	},
16	{
17	"field": "gender",
18	"operator": "in",
19	"value": [
20	"female",
21	"non-binary"
22	]
23	}
24	],
25	"workspace_id": "645e4403bdd06d5f66d8fbd8"
26	}'

1	{
2	"count": 42
3	}

Authentication

Request

Response

Errors