v6

latestOpenAPI 3.1.02026-08-08121441442.3 KB
filters

List all filters

List all filters that can be applied to your filter sets or studies.

get/api/v1/filters/

Query parameters

detailedstring

Include extra information required to sort and categorise filters in the Prolific app. This is not required for API use. Default false.

workspace_idstring

The workspace ID for the workspace you are creating a study or filterset in. This is used to get contextual data such as previous studies and participant groups.

filter_tagstring

Can be used to return only Custom Group filters.

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

Response

List of filters

_linksobject
metaobject