Skip to content

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
Languages
Servers

https://uberall.com/api/

Mock Server

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

Operations

Business Connections

Set up - Business Connections

Operations
Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Request

Disconnects the Dierctory User Account for the given sales partner and invalidates it if no other sales partner is connected to it

Security
X-API-KEY or Authorization
Path
idstringrequired

Sales Partner ID

accountIdstringrequired

Directory User Account ID

directoryTypestringrequired

Directory Type of User Account (in lower case)

curl -i -X POST \
  'https://uberall.com/api/sales-partners/{id}/user-accounts/{accountId}/{directoryType}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully disconnected Directory User Account

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

Update SSO Settings of a SalesPartner

Request

Can be used to update certain SSO settings for a single SalesPartner.

Security
X-API-KEY or Authorization
Path
idstringrequired

ID of the SalesPartner

Body*/*

Flag to indicate if single sign-on should be enforced. If enforced, users are allowed to log in via the single sign-on flow. Furthermore, the User's details such as name, email, feature, and others will be updatable via single sign-on only

forceSsoboolean
curl -i -X PATCH \
  'https://uberall.com/api/sales-partners/{id}/sso-settings' \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Successfully edited SalesPartner SSO settings

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.​salesPartnerobject

Sales Partner Model

Response
No content

Request

Can be used for searching through all children SalesPartner for the given parent SalesPartner

Security
X-API-KEY or Authorization
Query
idstring

Filter by specific uberall SalesPartner id

querystring

Filter by name or identifier

statusstring

Filter by status

sortstring

SalesPartner property used for pagination. Default: 'id'

orderstring

Order used for pagination. Default: 'asc'

maxinteger(int64)

Used for pagination. Maximum number of results per page. Default: 1000

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/sales-partners?id=string&query=string&status=string&sort=string&order=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved all child SalesPartners

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.​countinteger(int32)

The total count of found children

Example: 6
response.​pageCountinteger(int32)

The number of children on the current page

Example: 6
response.​maxinteger(int32)

The maximum number of results to return

Example: 10
response.​offsetinteger(int32)

The offset for pagination

Example: 0
response.​childrenArray of objects(SalesPartnerResponse)
Example: [{"id":270,"identifier":null,"name":"Dreamscape Networks FZ-LLC","privateKey":"c1Y3fRvwe0GHVEH5eM4TDZxousDwykwhv1lDRIhSeHAEVp5pLWiWdkbN3pJjwGBRATpQzXlh8MhIoYTaRX3MuyoDJBYHDwI3gJJIOjZX0KCGQj7HCdy7WEsc2Z66aFaD","status":"APPROVED"},{"id":464,"identifier":null,"name":"Touch Local Ltd","privateKey":"bWSWLIjiwIlUeToEeqvt8mS4DfSil5td9Lb06Xqbnmm5Z62cXTEAtN4UIG0pUtOr","status":"APPROVED"},{"id":3518,"identifier":null,"name":"Test Account","privateKey":"grB76Xs3qRBknUWvMoMHirTY8wfSJ2ipLyxX2rTBw63QCs45M6hh9DB5F8vBNgIFDoytsziYF8pA6XokCrVCqaOFzz5VR7Nj1W5sUWnpYXQdk1hLswvJrh2FIqIv2667","status":"APPROVED"},{"id":3519,"identifier":null,"name":"Web.com","privateKey":"zU2peIsy4VJGMuEnNmCdNfawF5hyQdw9pNk7sIdibljeAafuqjKFCb81yiyUcMfN9fstjpKFniRow6E5VGHWAB3rwJtY697PoFpnplPKnmhJaLoZlVpj2i7yzHhWVGhV","status":"APPROVED"},{"id":3763,"identifier":null,"name":"Network Solutions","privateKey":"sQwJtLBRPi3vV978gDyydnUx8YQsGRKvih3BI6Zcr965BTQ3GSM4LmJTenZChqZnPbJ6tY85Li5GEUnQAgAJf3JYarhu2i5lnWmY9mNG9MWSxVOhIrGk2dEvineVhyGO","status":"APPROVED"},{"id":3764,"identifier":null,"name":"Register.com","privateKey":"wsISftqTjOOdoPlz3b7elRN7pFW20tLs8nWRubmUScRWr0dfyxUmLAGpTXPwMeOkuRl2Y590R39cTUoPSuzVGTerLAaYkib7jjB5gTOtk0y3hvlPpyARHPW6NosApUOk","status":"APPROVED"}]
Response
No content
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
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
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