API Reference
/
Status Check

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

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

Returns a list of the last searches

Request

Returns a list of the last searches

Query
maxinteger(int64)

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

Example: max=50
offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/search?max=50&offset=0' \
  -H 'publicKey: YOUR_API_KEY_HERE'

Responses

Successfully retrieved status reports

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.​resultsArray of objects(SearchData)
response.​offsetinteger(int32)

The offset for pagination

Example: 0
response.​maxinteger(int32)

The maximum number of results to return

Example: 10
response.​countinteger(int32)

The total count of search data

Example: 100
Response
No content

Initiate a Search

Request

Initiate an online presence check starting with the name and address of the location

Query
namestringrequired

The name of the location

streetstringrequired

The street address of the location

streetNointeger(int64)

unless already in address field. The location's street number

zipinteger(int64)

Zip code

countrystringrequired

The country of the location Country. One of AT, CH, DE, ES, UK, FR, IT, NL

citystring

The city of the location

provincestring

The province of the location

latstring

The latitude of the location

lngstring

The longitude of the location

phonestring

The phone number of the location

curl -i -X POST \
  'https://docs.uberall.com/_mock/apis/swagger/search?city=string&country=string&lat=string&lng=string&name=string&phone=string&province=string&street=string&streetNo=0&zip=0' \
  -H 'publicKey: YOUR_API_KEY_HERE'

Responses

Successfully created search object

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

Search Data

response.​alreadyManagedboolean

Indicates if the search data is already managed

Example: true
Response
No content

Search in a Directory

Request

Search for a location identified by a uberall unique id in a specific directory

Path
idstringrequired

The unique id of the SearchData returned by /api/search/

Query
directorystring

The directory you want to search in

tokenstring

The token you got using /api/search

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/search/{id}?directory=string&token=string' \
  -H 'publicKey: YOUR_API_KEY_HERE'

Responses

Successfully searched directory

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

Basic Listings Model

Response
No content

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