Skip to content

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""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

Response object for a business directory account

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "id": 0,
    "accountId": "string",
    "name": "string",
    "usedInBusiness": 0,
    "canDisconnect": true
  }
}