Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
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

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

Get a list of Directory Pages

Request

Get several Directory Pages.

Query
typesstring

The directory types we want pages for.

levelsstring

String that represents the level of a directory page. The 2 possible values are "LISTING" and "BUSINESS"

locationIdsArray of strings

Return directory pages where input locationIds have access to

pageinteger(int64)

Used for pagination. Page number we're interested in

sizeinteger(int64)

Used for pagination. It indicates the amount of result to be returned in a single page

querystring

Filter by page name

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/social-posts/directory-pages?levels=string&locationIds=string&page=0&query=string&size=0&types=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Directory Pages 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

List Directory Pages Response Model

response.​pageinteger(int32)

The page number

response.​sizeinteger(int32)

The number of elements in the page

response.​totalSizeinteger(int64)

The total number of elements

response.​directoryPagesArray of objects(DirectoryPageResponse)

The list of directory pages

Response
No content

Validate the Apple CTA

Request

Check if the CTA is valid for an Apple post

Query
ctastringrequired

The call to action

locationIdsArray of stringsrequired

The location IDs

curl -i -X POST \
  'https://docs.uberall.com/_mock/apis/swagger/social-posts/validate-apple-cta?cta=string&locationIds=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

All locations support the CTA

Response
No content

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

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