List filter choices

GET

https://api.prolific.com/api/v1/filters/:filter_id/choices/

GET

/api/v1/filters/:filter_id/choices/

curl https://api.prolific.com/api/v1/filters/filter_id/choices/ \
     -H "Authorization: Token <token>"

{
  "results": [
    {
      "id": "100",
      "label": "Software developers",
      "parent_id": null,
      "num_children": 3,
      "num_descendants": 3
    },
    {
      "id": "101",
      "label": "Application software developer",
      "parent_id": "100",
      "num_children": 0,
      "num_descendants": 0
    }
  ],
  "meta": {
    "count": 5
  },
  "_links": {
    "self": {
      "href": "https://api.prolific.com/api/v1/filters/job-title/choices/?limit=2&offset=0",
      "title": "Current"
    },
    "next": {
      "href": "https://api.prolific.com/api/v1/filters/job-title/choices/?limit=2&offset=2",
      "title": "Next"
    },
    "previous": {
      "href": null,
      "title": "Previous"
    },
    "last": {
      "href": "https://api.prolific.com/api/v1/filters/job-title/choices/?limit=2&offset=3",
      "title": "Last"
    }
  }
}

Browse visible, valid choices in catalogue order, including selectable parents. Returns a flat, always-paginated collection without match metadata or nested children. Instructional participant-ID placeholders are not selectable choices. Empty enumerable filters return an empty collection. Permissions and catalogue restrictions apply before searching or counting. Self, next and previous links preserve applicable query and catalogue context, including workspace_id. Pagination links follow shared API conventions. Empty results retain the same envelope.

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

Path parameters

filter_idstringRequired

ID of a filter available in the resolved, permitted catalogue.

Query parameters

limitintegerOptional>=1Defaults to 25

Page size. Pagination applies even when this parameter is omitted.

offsetintegerOptional>=0Defaults to 0

Zero-based result offset. An offset beyond the collection returns an empty page.

workspace_idstringOptional

Workspace used to resolve accessible filters.

filter_bystringOptional

Catalogue filter type, for example participant.

filter_tagstringOptional

Restrict the catalogue by tag, for example custom-group.

include_deletedbooleanOptionalDefaults to false

Include deleted catalogue entities where supported.

include_deprecatedbooleanOptionalDefaults to false

Include deprecated filters.

distributablebooleanOptionalDefaults to false

Return only filters supporting breakdown distribution.

Response

List filter choices

resultslist of objects

metaobject

_linksobject

Errors

400

Bad Request Error

4XX

Client Request Error

403

Forbidden Error

404

Not Found Error