List all filters | Prolific API

curl -G https://api.prolific.com/api/v1/filters/ \
     -H "Authorization: Token <token>" \
     -d filter_tag=custom-group

{
  "results": [
    {
      "filter_id": "handedness",
      "title": "Handedness",
      "description": "Whether a person is left or right-handed.",
      "question": "Are you left or right-handed?",
      "type": "select",
      "data_type": "ChoiceID",
      "choices": {
        "0": "Right-handed",
        "1": "Left-handed",
        "2": "Ambidextrous"
      }
    },
    {
      "filter_id": "previous_studies",
      "title": "Previous Studies AllowList",
      "description": "Select one or more studies to allow participants who have completed them to participate in this study.",
      "type": "select",
      "data_type": "StudyID",
      "choices": {
        "645e4403bdd06d5f66d8fbd5": "Study 1 internal name",
        "645e4403bdd06d5f66d8fbd8": "Study 2 internal name",
        "645e4403bdd06d5f66d8fbdb": "Study 3 internal name"
      }
    },
    {
      "filter_id": "custom_allowlist",
      "title": "Custom AllowList",
      "description": "Select one or more participant ID's to allow participants to complete this study.",
      "type": "select",
      "data_type": "ParticipantID",
      "choices": {
        "0": "Add a list of participant ID's to create an allowlist filter."
      }
    },
    {
      "filter_id": "age",
      "title": "Age",
      "question": "How old are you?",
      "description": "",
      "type": "range",
      "data_type": "integer",
      "min": 18,
      "max": 100
    },
    {
      "filter_id": "joined_between",
      "title": "Joined Between",
      "description": "Allow participants who joined between the specified dates to participate in this study.",
      "type": "range",
      "data_type": "date",
      "min": "2020-01-01",
      "max": "2021-01-01"
    }
  ]
}

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

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

detailedstringOptional

Include extra information required to sort and categorise filters in the Prolific app. This is not required for API use. Default false.

workspace_idstringOptional

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.

filter_tagstringOptional

Can be used to return only Custom Group filters.

Response

List of filters

resultslist of objects or null

_linksmap from strings to any or null

metamap from strings to any or null

Authentication

Query parameters

Response

Errors