PRprolific
filters

List all filters

Changed on

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

get/api/v1/filters/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/filters/
  • Auth
    API key in header Authorization

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. It also controls whether matching_parameters_config is returned on the previous studies allowlist and blocklist filters, which only happens when detailed is true and min/max matching bounds are available to you. When workspace_id resolves to a workspace, availability is also checked for that workspace.

filter_tagstring

Can be used to return only Custom Group filters.

include_deprecatedboolean

When true, deprecated filters are included in the response. Defaults to false. Used by the UI to resolve deprecated filters applied to existing studies.

Response

List of filters

_linksobject
metaobject

Changes

  • 9cabd62d103fRevision changes
    • info

      added the optional property /// to the response with the status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API