Get all filter options

GET

https://v1.api.partnerpage.io/api/directory/private/v1alpha/filters/:filterId/options/

GET

/api/directory/private/v1alpha/filters/:filterId/options/

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

[
  {
    "0": {
      "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"
    },
    "1": {
      "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/006059d7-4d1e-4ace-b816-32fa9a9659ac/options/ce98b73d-3784-4186-9cb5-3eb5450b7c98/",
      "id": "ce98b73d-3784-4186-9cb5-3eb5450b7c98",
      "image": "https://image.domain.com/partner.png",
      "imageUrl": "https://image.domain.com/partner.png",
      "name": "Second Option",
      "order": 1,
      "slug": "second-option"
    },
    "href": "string",
    "id": "string",
    "name": "string",
    "order": 1,
    "slug": "string",
    "image": "string",
    "imageUrl": "string",
    "filter": "function filter() { [native code] }",
    "parentOptionId": "string",
    "parentOptionSlug": "string"
  }
]

Retrieve a list of filter options within a filter

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the directory containing the filter options

filterIdstringRequiredformat: "uuid"

ID of the filter containing the options

Response

List of filter options in the filter

hrefstringRead-only

idstringformat: "uuid"

namestring

orderinteger>=0

slugstring

imagestring or null

imageUrlstring or null

filterstringformat: "uuid"

parentOptionIdstringformat: "uuid"

parentOptionSlugstring

hasResultsboolean or nullOptional

Errors

404

Not Found Error