API Reference
/
Configuration

Uberall API (20250204)

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
Mock server

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

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Get All Directory Brands

Request

Returns a list of directory brands for the given account and directory

Path
salesPartnerIdstringrequired

Sales Partner ID

accountIdstringrequired

Directory User Account ID

directoryTypestringrequired

Type of Directory

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/directory-brand/sales-partner/{salesPartnerId}/user-account/{accountId}/{directoryType}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Directory Brands

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

Page response for directory brands

response.​brandsArray of objects(DirectoryExternalBrandResponse)
response.​nextPageOffsetstring

offset for the next page from the external directory

Example: "10"
Response
No content

Create Directory Brand

Request

Create directory brand for the given sales partner id, directory user account and directory type

Path
salesPartnerIdstringrequired

Sales Partner ID

accountIdstringrequired

Directory User Account ID

directoryTypestringrequired

Type of Directory

Body*/*required

Details for creating a directory brand

namestringrequired

Name for the directory brand

countrystringrequired

Country for the directory brand

categorystringrequired

Category for the directory brand

urlstringrequired

Website URL for the directory brand

appLinkstring

AppLink for the directory brand

curl -i -X POST \
  'https://docs.uberall.com/_mock/apis/swagger/directory-brand/sales-partner/{salesPartnerId}/user-account/{accountId}/{directoryType}' \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Successfully created Directory Brand

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

External ID of the directory brand

Example: "12345"
response.​statusstring

Status of the directory brand

Example: "active"
response.​namesArray of strings
response.​idinteger(int64)
response.​categoriesArray of strings
response.​countrystring
Response
No content

Get All Directories details by country

Request

Returns a list of directories details filtered by country

Query
countriesstring

Optional list parameter of comma separated ISO 3166 alpha-2 country codes to filter response

Example: countries=US, DE
curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/directories/directories-details/countries?countries=US%2C%20DE' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Directories Details

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.​itemsArray of objects(DirectoriesDetailsCountry)
response.​countinteger(int32)

Total count of countries

Example: 195
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​nextOffsetinteger(int32)

Next offset for pagination

Example: 10
Response
No content

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

Social Posting Templates

Products - Social Posting - Social Posting Templates

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

Menu Items

Locations Hub - Locations - Menu Items

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