Get a filter

GET

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

GET

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

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

{
  "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/006059d7-4d1e-4ace-b816-32fa9a9659ac/",
  "id": "006059d7-4d1e-4ace-b816-32fa9a9659ac",
  "type": "user",
  "name": "Filter 1",
  "slug": "filter-1",
  "order": 0,
  "parentFilterId": "string",
  "parentFilterSlug": "string",
  "filterOptions": "string",
  "multipleSelectFromDashboard": false,
  "multipleSelectFromDirectory": false,
  "userAssignable": true,
  "displayInDirectory": true,
  "displayInInternalDirectory": false,
  "displayInEntryProfile": true,
  "displayInInternalEntryProfile": true,
  "displayInEntryProfileMainArea": true,
  "required": false,
  "overrides": {
    "attributes": [
      {
        "attribute": "string",
        "value": true
      }
    ],
    "conditions": [
      {
        "key": "string",
        "operator": "equals",
        "value": "string"
      }
    ]
  },
  "assignmentDescription": "Assignment description",
  "multipleLimit": null,
  "genericDirectory": "969d9b77-c063-4101-b534-63071317ddbd",
  "userEnabled": true
}

Retrieve details of a single filter within a directory

Authentication

AuthorizationToken

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

Path parameters

filterIdstringRequiredformat: "uuid"

ID of the filter to retrieve

Response

Details of the filter

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