Get filter set

GET

https://api.prolific.com/api/v1/filter-sets/:id/

GET

/api/v1/filter-sets/:id/

$ curl https://api.prolific.com/api/v1/filter-sets/id/ \
>      -H "Authorization: Token <token>"

1 {
2   "id": "string",
3   "version": 1,
4   "is_deleted": true,
5   "is_locked": true,
6   "workspace_id": "string",
7   "organisation_id": "string",
8   "name": "string",
9   "description": "string",
10   "filters": [
11     {
12       "filter_id": "or",
13       "selected_filters": [
14         {
15           "filter_id": "and",
16           "selected_filters": [
17             {
18               "filter_id": "participant_group_allowlist",
19               "selected_values": [
20                 "644aaabfaf6bbc363b9d47c6"
21               ]
22             },
23             {
24               "filter_id": "age",
25               "selected_range": {
26                 "lower": 18,
27                 "upper": 30
28               }
29             }
30           ]
31         },
32         {
33           "filter_id": "and",
34           "selected_filters": [
35             {
36               "filter_id": "previous_studies_allowlist",
37               "selected_values": [
38                 "644ab312af6bbc363b9d47c7"
39               ]
40             },
41             {
42               "filter_id": "approval_rate",
43               "selected_range": {
44                 "lower": 95
45               }
46             }
47           ]
48         }
49       ]
50     }
51   ],
52   "eligible_participant_count": 1
53 }

Get details of a filter set.

Authentication

AuthorizationToken

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

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

Path parameters

idstringRequired

ID of the filter set.

Query parameters

version_numberintegerOptional

Allows you to specify a specific version of the filter set to retrieve.

Response

Filter set details

idstringOptional

ID of the filter set.

versionintegerOptional

An incrementing integer indicating the version of the filter set.

is_deletedbooleanOptional

Whether the filter set has been deleted.

is_lockedbooleanOptional

Whether the filter set has been locked.

workspace_idstring or nullOptional

ID of the workspace where the filter set can be used.

organisation_idstring or nullOptional

ID of the workspace where the filter set can be used.

namestringOptional

Name of the filter set.

descriptionstring or nullOptional<=2048 characters

Description of the filter set.

filterslist of objectsOptional

List of all filters contained in the filter set.

eligible_participant_countintegerOptional

The number of participants who match the filter sets filters. Please note that if the number is lower than 5 the count will be obscured to prevent identification of participants.

Errors

4XX

Client Request Error