Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
filters

Count participants

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.

post/api/v1/eligibility-count/

Headers

Authorizationstring required

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>.

Request body

workspace_idstring

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_idstring

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

Response

Count

countnumber double required

Number of participants passing all the requirements