API ReferenceFilter Sets

Create filter set

View as MarkdownOpen in Claude
Create a filter set from a list of filters

Authentication

Authorizationstring
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

This endpoint expects an object.
workspace_idstringOptional
ID of the workspace where the filter set can be used.
organisation_idstringOptional
ID of the organisation where the filter set can be used.
namestringOptional
Name of the filter set.
filterslist of objectsOptional
List of all filters contained in the filter set.

Response

Filter set created
eligible_participant_countinteger or null
The number of participants who match the filter sets filters. Please note that if the number is lower than 25 the count will be obscured to prevent identification of participants.
filterslist of objects or null
List of all filters contained in the filter set.
idstring or null
ID of the filter set.
is_deletedboolean or null
Whether the filter set has been deleted.
is_lockedboolean or null
Whether the filter set has been locked.
namestring or null
Name of the filter set.
organisation_idstring or null
ID of the workspace where the filter set can be used.
versioninteger or null
An incrementing integer indicating the version of the filter set.
workspace_idstring or null
ID of the workspace where the filter set can be used.

Errors