Skip to content
API Reference
/
Business Connections
/
Get business connections by directory type

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers

https://uberall.com/api/

Mock Server

https://docs.uberall.com/_mock/apis/swagger/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

List of all directory user accounts connected to sales partner

Request

Get list of all the directory user accounts that correspond to all connected accounts on given salesPartner (e.g. list of all the accounts that have been authenticated under sp)

Security
X-API-KEY or Authorization
Path
directoryTypestringrequired

Type of the directory

salesPartnerIdstringrequired

Id of the SalesPartner

Query
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}/users?max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

External entities successfully retrieved

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Response object for a business directory account

response.​idinteger(int64)

The ID of the account

response.​accountIdstring

The external ID of the account

response.​namestring

The name of the account as it appears on the directory

response.​usedInBusinessinteger(int32)

Number of business connections that belong to this account

response.​canDisconnectboolean

Indicates if the account can be removed

Response
No content

Get business connections by directory type

Request

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

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'

Responses

Successfully retrieved business connections

Body*/*
businessConnectionsArray of objects(BusinessConnectionItem)
maxinteger(int32)

Maximum number of items returned

offsetinteger(int32)

Offset used for pagination

countinteger(int64)

Total number of items available across all pages

Response
No content

List of business connections

Request

Get detailed list of business connections created under given salesPartner

Security
X-API-KEY or Authorization
Path
directoryTypestringrequired

Type of the directory

salesPartnerIdstringrequired

Id of the SalesPartner

Query
statusstringrequired

Filter by status

namestring

Filters results by performing search with given value

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}/list?status=string&name=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Business connections successfully retrieved

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
No content

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations