Get all callouts

GET

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

GET

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

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

200Example response

[
  {
    "0": {
      "backgroundColor": null,
      "href": "/api/directory/private/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/callouts/cdc0f6d9-9261-4e5d-956f-c980440452b7/",
      "id": "cdc0f6d9-9261-4e5d-956f-c980440452b7",
      "name": "Accounting",
      "textColor": "635BFF"
    },
    "1": {
      "backgroundColor": "E8E6FF",
      "href": "/api/directory/private/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/callouts/e071a25d-007c-479c-be1f-50a8970210c6/",
      "id": "e071a25d-007c-479c-be1f-50a8970210c6",
      "name": "CRM",
      "textColor": null
    },
    "href": "string",
    "name": "string",
    "id": "string"
  }
]

Return the list of callouts details information belonging to a directory

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the directory containing the callouts

Response

Successful operation

hrefstringRead-only

namestring<=35 characters

idstringformat: "uuid"

textColorstring or nullOptionalformat: "^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"<=7 characters

backgroundColorstring or nullOptionalformat: "^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"<=7 characters