List all filter sets

GET

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

GET

/api/v1/filter-sets/

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

{
  "results": [
    {
      "id": "string",
      "version": 1,
      "is_deleted": true,
      "is_locked": true,
      "workspace_id": "string",
      "organisation_id": "string",
      "name": "string",
      "description": "string",
      "filters": [
        {
          "filter_id": "or",
          "selected_filters": [
            {
              "filter_id": "and",
              "selected_filters": [
                {
                  "filter_id": "participant_group_allowlist",
                  "selected_values": [
                    "644aaabfaf6bbc363b9d47c6"
                  ]
                },
                {
                  "filter_id": "age",
                  "selected_range": {
                    "lower": 18,
                    "upper": 30
                  }
                }
              ]
            },
            {
              "filter_id": "and",
              "selected_filters": [
                {
                  "filter_id": "previous_studies_allowlist",
                  "selected_values": [
                    "644ab312af6bbc363b9d47c7"
                  ]
                },
                {
                  "filter_id": "approval_rate",
                  "selected_range": {
                    "lower": 95
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

List of all filter sets in the specified workspace.

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

Query parameters

workspace_idstringOptional

ID of the workspace to get filter sets for.

organisation_idstringOptional

ID of the organisation to get filter sets for.

Response

List of filter sets

resultslist of objectsOptional

List of filter sets.

Errors

4XX

Client Request Error