Get business connections by directory type

Request

Retrieves a list of businesses and their connection types for a specific directory type. Returns up to 50 entries that match the optional filter criteria.

Security

X-API-KEY or Authorization

Path

directoryTypestringrequired

Type of the directory

Query

searchQuerystring, [ 1 .. 255 ] characters

Filter string applied to business name and business identifier using OR logic

maxinteger, (int64)

Maximum number of items to return. Default: 50

offsetinteger, (int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/business-connections/{directoryType}?searchQuery=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved business connections

Body*/*

businessConnectionsArray of objects

maxinteger, (int32)

Maximum number of items returned

offsetinteger, (int32)

Offset used for pagination

countinteger, (int64)

Total number of items available across all pages

Response

{
  "businessConnections": [
    {
      "id": 12345,
      "name": "Pizza Palace Downtown",
      "identifier": "pizza-palace-001",
      "type": "BUSINESS_LEVEL"
    }
  ],
  "max": 0,
  "offset": 0,
  "count": 0
}