List all external entities

Request

Get list of all the external entities on directories on given salesPartner that correspond to specified account.

Security

X-API-KEY or Authorization

Path

directoryTypestringrequired

Type of the directory

salesPartnerIdstringrequired

Id of the SalesPartner

accountIdstringrequired

Id of the DirectoryUserAccount

Query

querystring

Search filter for page name.

maxinteger, (int64)

Maximum number of items to return

offsetinteger, (int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/business-connections/{directoryType}/sales-partner/{salesPartnerId}/account/{accountId}/pages?query=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

External entities successfully retrieved

Body*/*

statusstring

Available statuses

Enum:"SUCCESS""PENDING""ERROR"

Example:"SUCCESS"

pagesArray of objects

The list of pages (empty if status is not SUCCESS)

Response

{
  "status": "SUCCESS",
  "pages": [
    {
      "id": "string",
      "accountId": 0,
      "name": "string",
      "link": "string",
      "usedInBusiness": 0,
      "managedByAccount": true,
      "type": "BRAND_AND_LOCATIONS",
      "metrics": {},
      "connection": {}
    }
  ]
}