Get all filters

GET

https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/:directoryId/filters/

GET

/api/directory/private/v1alpha/directories/:directoryId/filters/

curl https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/directoryId/filters/ \
     -H "Authorization: Token  <apiKey>"

[
  {
    "0": {
      "assignmentDescription": "Assignment description",
      "filterOptions": [
        {
          "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/006059d7-4d1e-4ace-b816-32fa9a9659ac/options/64f0fab6-32a4-4205-991b-d4eb87e82da2/",
          "id": "64f0fab6-32a4-4205-991b-d4eb87e82da2",
          "image": "https://image.domain.com/partner.png",
          "imageUrl": "https://image.domain.com/partner.png",
          "name": "First Option",
          "order": 0,
          "slug": "first-option"
        }
      ],
      "genericDirectory": "969d9b77-c063-4101-b534-63071317ddbd",
      "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/006059d7-4d1e-4ace-b816-32fa9a9659ac/",
      "id": "006059d7-4d1e-4ace-b816-32fa9a9659ac",
      "multipleLimit": null,
      "multipleSelectFromDashboard": false,
      "multipleSelectFromDirectory": false,
      "name": "Filter 1",
      "order": 0,
      "required": false,
      "slug": "filter-1",
      "type": "user",
      "userEnabled": true
    },
    "1": {
      "assignmentDescription": null,
      "displayInDirectory": true,
      "displayInInternalDirectory": false,
      "filterOptions": [
        {
          "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/032069d1-4a4e-7ace-b51-32fa9a9114dz/options/858e16bd-becd-4ccf-a07e-ef3917844bd9/",
          "id": "858e16bd-becd-4ccf-a07e-ef3917844bd9",
          "image": "https://image.domain.com/partner.png",
          "imageUrl": "https://image.domain.com/partner.png",
          "name": "Second Option",
          "order": 1,
          "slug": "second-option"
        }
      ],
      "genericDirectory": "969d9b77-c063-4101-b534-63071317ddbd",
      "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/032069d1-4a4e-7ace-b51-32fa9a9114dz/",
      "id": "032069d1-4a4e-7ace-b51-32fa9a9114dz",
      "multipleLimit": null,
      "multipleSelectFromDashboard": false,
      "multipleSelectFromDirectory": false,
      "name": "Filter 2",
      "order": 1,
      "required": false,
      "slug": "filter-1",
      "type": "user",
      "userEnabled": true
    },
    "href": "string",
    "id": "string",
    "type": "string",
    "name": "string",
    "slug": "string",
    "order": 1,
    "parentFilterId": "string",
    "parentFilterSlug": "string",
    "filterOptions": "string",
    "multipleSelectFromDashboard": true,
    "multipleSelectFromDirectory": true,
    "userAssignable": true,
    "displayInDirectory": true,
    "displayInInternalDirectory": true,
    "displayInEntryProfile": true,
    "displayInInternalEntryProfile": true,
    "displayInEntryProfileMainArea": true,
    "required": true,
    "overrides": {
      "attributes": [
        {
          "attribute": "string",
          "value": true
        }
      ],
      "conditions": [
        {
          "key": "string",
          "operator": "equals",
          "value": "string"
        }
      ]
    }
  }
]

Retrieve a list of filters within a directory

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the directory containing the filters

Response

List of filters in the directory

hrefstringRead-only

idstringformat: "uuid"

typestring

namestring<=150 characters

slugstring

orderinteger>=0

parentFilterIdstringformat: "uuid"

parentFilterSlugstring

filterOptionsstringRead-only

multipleSelectFromDashboardboolean

multipleSelectFromDirectoryboolean

userAssignableboolean

displayInDirectoryboolean

displayInInternalDirectoryboolean

displayInEntryProfileboolean

displayInInternalEntryProfileboolean

displayInEntryProfileMainAreaboolean

requiredboolean

overridesobject or null

Visibility rule of the filter, or null when it has none.

assignmentDescriptionstring or nullOptional<=150 characters

multipleLimitinteger or nullOptional1-250

isLocationbooleanOptionalDefaults to false

Whether this is one of the Country, Region and City filters, which visitors pick from as one Location filter.

Errors

404

Not Found Error