Skip to content
/Configuration

Get All Directory Brands

Request

Returns a list of directory brands for the given account and directory

Security
X-API-KEY or Authorization
Path
salesPartnerIdstringrequired

Sales Partner ID

accountIdstringrequired

Directory User Account ID

directoryTypestringrequired

Type of Directory

curl -i -X GET \
  'https://uberall.com/api/directory-brand/sales-partner/{salesPartnerId}/user-account/{accountId}/{directoryType}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Directory Brands

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Page response for directory brands

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "brands": [
      {
        "id": "1",
        "names": [
          "['BrandName1', 'BrandName2']"
        ],
        "countryCode": "US",
        "categories": [
          {
            "id": 0,
            "type": "FOURSQUARE",
            "name": "Autowerkstatt",
            "externalId": "12345",
            "parent": null,
            "selectable": false,
            "dateCreated": "2023-01-01T00:00:00Z",
            "lastUpdated": "2023-01-01T00:00:00Z",
            "country": "AF"
          }
        ],
        "urls": [
          {}
        ],
        "etag": "etag123",
        "state": "active",
        "locationsCount": 10,
        "photos": {
          "description": "string",
          "sourceUrl": "string",
          "identifier": "string",
          "cropOffsetX": 0,
          "cropOffsetY": 0,
          "cropWidth": 0,
          "cropHeight": 0
        },
        "ownershipType": "BRAND_OWNER"
      }
    ],
    "nextPageOffset": "10"
  }
}