Get filter set | Prolific API

Get details of a filter set.

Authentication

AuthorizationToken

Header authentication of the form Token <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

eligible_participant_countinteger

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

List of all filters contained in the filter set.

idstring

ID of the filter set.

is_deletedboolean

Whether the filter set has been deleted.

is_lockedboolean

Whether the filter set has been locked.

namestring

Name of the filter set.

organisation_idstring or null

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

versioninteger

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

4XX

Client Request Error

1	{
2	"eligible_participant_count": 245,
3	"filters": [
4	{
5	"filter_id": "status-filter",
6	"selected_values": [
7	"active",
8	"pending"
9	],
10	"weightings": {
11	"active": 0.8,
12	"pending": 0.2
13	}
14	}
15	],
16	"id": "a3f47b2e-9c4d-4f1a-8b2e-3d5f7a9c1e2b",
17	"is_deleted": false,
18	"is_locked": true,
19	"name": "Active Users Filter Set",
20	"organisation_id": "org-5678",
21	"version": 3,
22	"workspace_id": "workspace-1234"
23	}

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