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

The actual response object of the response

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {}
}