Skip to content
API Reference/
/
Get the province/state fo...

Uberall API (20260101)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api
Mock Server
https://docs.uberall.com/_mock/apis/swagger

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 Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social AI Service

Products - Social AI Service

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

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 post / zip code for locations

Request

Get the post / zip code assigned to a location

Security
X-API-KEY or Authorization
Query
locationIdsArray of strings

Get the post / zip codes for associated to the given list of location Ids

businessIdsArray of strings

Get the post / zip codes for locations assigned to a business id

countriesArray of strings

Get the post / zip codes for locations within a country

provincesArray of strings

Get the post / zip codes for locations within a province / state

citiesArray of strings

Get the post / zip codes for locations within a city

querystring

Restricts the response to the post/zip codes that contain this text, for example "374" would return "37490" when appropriate.

maxinteger(int64)

Maximum number of items to return

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/locations/postcodes?locationIds=string&businessIds=string&countries=string&provinces=string&cities=string&query=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Postcodes 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

Response object containing a list of postcodes

response.​postcodesArray of strings
Response
No content

Get the province/state for locations

Request

Get a list of provinces/states, for locations available to the user, with filtering on businesses, countries, or a search text

Security
X-API-KEY or Authorization
Query
businessIdsArray of strings

Get the provinces / states of locations associated with specific Business Id(s)

countriesArray of strings

Get provinces / states for locations in a country

querystring

Restricts the response to the provinces/states that contain this text, for example 'indi' would return 'Indiana' when appropriate.

maxinteger(int64)

Maximum number of items to return

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/locations/provinces?businessIds=string&countries=string&query=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Provinces 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

Provinces response model

response.​provincesArray of strings

List of provinces

Example: ["Province1","Province2"]
Response
No content

Get Locations' Statistics

Request

Get statistics about the locations the current user is managing: total and breakdown by status

Security
X-API-KEY or Authorization
curl -i -X GET \
  https://uberall.com/api/locations/statistics \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Location statistics successfully retrieved

Bodyapplication/json
countinteger(int32)

Total number of locations

countActiveinteger(int32)

Number of active locations

countInactiveinteger(int32)

Number of inactive locations

countCancelledinteger(int32)

Number of cancelled locations

countClosedinteger(int32)

Number of closed locations

countSyncStartedinteger(int32)

Number of locations where sync has been started

countSyncNotStartedinteger(int32)

Number of locations where sync has not been started

countSyncNeededinteger(int32)

Number of locations where sync is needed

suggestionsAvailableboolean

true if any suggetions are available

Response
application/json
{
  "count": 0,
  "countActive": 0,
  "countInactive": 0,
  "countCancelled": 0,
  "countClosed": 0,
  "countSyncStarted": 0,
  "countSyncNotStarted": 0,
  "countSyncNeeded": 0,
  "suggestionsAvailable": true
}

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