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

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

Get the city for locations

Request

Get the location's city

Query
locationIdsArray of strings

Get the cities for locations by location Ids

businessIdsArray of strings

Get the cities for locations by business id

postcodesArray of strings

Get the cities for locations by postcodes

countriesArray of strings

Get the cities for locations by country

provincesArray of strings

Get the cities for locations by province / state

querystring

Restricts the response to the cities that contain this text, for example "ber" would return "Berlin" when appropriate.

maxinteger(int64)

Maximum number of items to return

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/cities?businessIds=string&countries=string&locationIds=string&max=0&offset=0&postcodes=string&provinces=string&query=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Cities successfully 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

Cities response model

response.​citiesArray of strings

List of cities

Example: ["City1","City2"]
Response
No content

Get the country for locations

Request

Get the country for each location

Query
businessIdsstringrequired

The business ids for the locations that should be returned

maxinteger(int64)

Maximum number of items to return

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/countries?businessIds=string&max=0&offset=0' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Countries successfully 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

CountriesResponse Model

response.​countriesArray of strings

List of countries

Example: ["Country1","Country2"]
Response
No content

Get Several Locations

Request

Get locations managed by the current API user. Some fields are omitted (such as paymentOptions and services). For a full list use the GET/api/locations/$id endpoint.

Query
businessIdArray of integers(int64)

Only return locations in the business identified by businessId. Allowed multiple businessIds

Example: businessId=/api/locations?businessId=123&businessId=456
businessIdsArray of integers(int64)

Returns all locations associated with multiple business ids

citiesArray of strings

Get locations in the requested cities

classificationstring

Possible values: REQUIRED, BASIC, ADVANCED, BONUS and COMPLETE

countriesArray of strings

Get locations in the requested country

endDateMaxstring(date-time)

Only locations with an endDate less than or equal to endDateMax will be returned

Example: endDateMax=2020-02-05T12:18:12.000+01:00
endDateMinstring(date-time)

Only locations with an endDate greater than or equal to endDateMin will be returned.

Example: endDateMin=2018-02-05T12:18:12.000+01:00
excludedLocationIdsArray of integers(int64)

List of locationIds that should be excluded from the result

Example: excludedLocationIds=excludedLocationIds=20&excludedLocationIds=21 for multiple locations
facebookStatusstring

Possible values: CONNECTED, NOT_CONNECTED

fieldMaskArray of strings

Possible fieldMask options ( 'id', 'name', 'identifier', 'street', 'streetNo', 'streetAndNumber', 'addressExtra', 'zip', 'city', 'country', 'dateCreated', 'endDate', 'province', 'lat', 'lng', 'addressDisplay', 'phone', 'fax', 'timeZone', 'cellphone', 'website', 'email', 'legalIdent', 'taxNumber', 'descriptionShort', 'descriptionLong', 'imprint', 'openingHoursNotes', 'status', 'photos', 'attributes', 'firstSyncStarted', 'lastUpdated', 'lastSyncStarted', 'autoSync', 'locationSyncable', 'businessId', 'businessName', 'productPlanName', 'googleInsights', 'labels', 'customFields', 'features', 'groups', 'openingHours', 'specialOpeningHours', 'nameDescriptor', 'actionsRequired', 'profileCompleteness', 'suggestionsForFieldsAvailable', 'listingsInSync', 'activeListingsCount', 'dataPoints', 'averageRating', 'directoriesMissingConnect' )

Example: fieldMask=fieldMask=city&fieldMask=zip
googleDirectoryStatusstring

Possible values: VERIFIED (the Google listing is verified and fully managed by us), UNVERIFIED (the Google listing is not verified), DISABLED (the Google listing is disabled), SUSPENDED (the Google listing is suspended), DUPLICATE (the Google listing is a duplicate), PENDING_VERIFICATION (a verification pin has been requested for the Google listing), NEEDS_REVERIFICATION (the verification process for the Google listing needs to be reverified), PENDING_REVIEW (there is no Google account connected for the listing)

googleStatusstring

Possible values: VERIFIED (the Google listing is verified and fully managed by us), VERIFICATION_STARTED (a verification pin has been requested for the Google listing), VERIFICATION_NOT_STARTED (the verification process has not been start for the Google listing), NOT_CONNECTED (there is no Google account connected for the listing), VERIFIED_BY_THIRD_PARTY (there is a verified listing on Google but we do not manage it)

groupIdsArray of integers(int64)

The groupId to which the location belongs

groupsArray of strings

The name of the group to which the location belongs

identifierstring

Only return one location (per business) based on your internal identification system

labelsArray of strings

Only return locations that contain at least one of the given labels

locationIdsArray of integers(int64)

Only return locations identified by ids listed in locationIds

Example: locationIds=?locationIds=20&locationIds=22 for multiple locations
maxinteger(int64)

Used for pagination. Maximum number of results per page. Default: 50 (Without a defined FieldMask the maximum number of results is 50.)

missingDirectoryFieldArray of strings

Only return locations that have no value for the given field

needsReviewboolean

If set to true, only return locations with faulty data in need of review. Default: false.

offsetinteger(int64)

Offset used for pagination. Default: 0

orderstring

use asc for ascending sort or desc for descending sort

postcodesArray of strings

Get locations in the requested post / zip codes

provincesArray of strings

Get locations in the requested province / state

querystring

Filter by name, zip, street, city, label

Example: query=Berlin
queryFieldsArray of strings

The fields that will be searched to contain the value provided in the 'query' query parameter.

selectAllboolean

Setting selectAll to true allows finding ALL locations for any given businessId, locationIds and labels. In other words these fields are OR joined.

sortstring

The location property to sort by (ascending unless order is specified). One of name, street, streetNo, zip, city, phone, cellphone, fax, website, email, lastSyncStarted, country

statusArray of strings

Filter by locations status. One of ACTIVE, INACTIVE, CANCELLED

syncNeededboolean

If set to true, filter locations that have been updated but did not start a sync yet

syncStartedboolean

If set to true, filter locations that started a sync. If set to false, filter locations that never synced

temporarilyClosedboolean

Filter for locations that are currently set to temporarily closed (True) or are not temporarily closed (False)

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations?businessId=%2Fapi%2Flocations%3FbusinessId%3D123%26businessId%3D456&businessIds=0&cities=string&classification=string&countries=string&endDateMax=2020-02-05T12%3A18%3A12.000%2B01%3A00&endDateMin=2018-02-05T12%3A18%3A12.000%2B01%3A00&excludedLocationIds=excludedLocationIds%3D20%26excludedLocationIds%3D21%20for%20multiple%20locations&facebookStatus=string&fieldMask=fieldMask%3Dcity%26fieldMask%3Dzip&googleDirectoryStatus=string&googleStatus=string&groupIds=0&groups=string&identifier=string&labels=string&locationIds=%3FlocationIds%3D20%26locationIds%3D22%20for%20multiple%20locations&max=0&missingDirectoryField=string&needsReview=true&offset=0&order=string&postcodes=string&provinces=string&query=Berlin&queryFields=string&selectAll=true&sort=string&status=string&syncNeeded=true&syncStarted=true&temporarilyClosed=true' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Locations successfully retrieved

Bodyapplication/json
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.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​countinteger(int32)

Total count of results

Example: 100
response.​locationsArray of objects(LocationSearchResult)
Response
application/json
{ "status": "SUCCESS", "message": "string", "warnings": [ "string" ], "response": { "offset": 0, "max": 10, "count": 100, "locations": [] } }

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