Get all filters for external directory

GET

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

GET

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

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

[
  {
    "id": "string",
    "name": "string",
    "order": 1,
    "type": "string",
    "filterOptions": "string",
    "multipleSelectFromDashboard": true,
    "isDirectoryManaged": true,
    "required": true,
    "userAssignable": true,
    "overrides": {
      "attributes": [
        {
          "attribute": "string",
          "value": true
        }
      ],
      "conditions": [
        {
          "key": "string",
          "operator": "equals",
          "value": "string"
        }
      ],
      "conditionCombinator": "and"
    },
    "assignmentDescription": "string",
    "multipleLimit": 1
  }
]

Retrieve a list of filters for an external directory

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the external directory

Response

List of filters in the external directory

idstringformat: "uuid"

namestring<=150 characters

orderinteger>=0

typestring<=7 characters

filterOptionsstringRead-only

multipleSelectFromDashboardboolean

isDirectoryManagedboolean

requiredboolean

userAssignableboolean

overridesobject or null

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

assignmentDescriptionstring or nullOptional<=150 characters

multipleLimitinteger or nullOptional1-250

Errors

404

Not Found Error