Skip to content

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

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

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

Get All Service Items

Request

Get all service items the current API user can manage.
To specify services with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 in the URL param

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

Responses

Service Items 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

The actual response object of the response

response.​querystring

The search query

Example: "service"
response.​offsetinteger(int32)

The offset for pagination

Example: 0
response.​maxinteger(int32)

The maximum number of results to return

Example: 10
response.​serviceItemsArray of objects
Response
No content

Create a Service Item

Request

Create a menu item. It can be added to a content collection later

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A ServiceItem object

titlestringrequired

Name of the service item as represented at the location

descriptionstring

A description of the service

identifierstring

Required - A unique identifier for this service

listNamestring
priceinteger(int32)

Minimum price of the service item. Amounts must be provided in the smallest valid unit of the respective currency (e.g., USD - cents, 10.99 USD → 1099). See range interpretation rules under priceMax.

currencystring

The currency of price and priceMax for this service (required when a price is given). Amounts for price fields must be expressed in the smallest valid unit of this currency (e.g., USD - cents).

Example: "USD"
categoryinteger(int64)

Business category the service should be applied to - this is required when applying a Google structured service but not necessary for freeform services.

countrystring

The country where the locations providing this service are located - this is required when applying a Google structured service but not necessary for freeform services.

googleServicestring

The Google name for a structured service - this is required when applying a Google structured service but not necessary for freeform services.

priceMaxinteger(int32)

Maximum price for the item when using a price range. Amounts must be provided in the smallest valid unit of the respective currency (e.g., USD → cents). Range interpretation rules:

  • Exact: price == priceMax

  • Starts At: priceMax == null (only minimum known)

  • Range: price < priceMax (both known and different)

  • Not Interpreted: price is null (minimum unknown)

Validation: if provided, priceMax must be a non-negative integer and greater than or equal to price.

urlstring

A valid page url with more details about the item.

durationinteger(int32)

Minimum duration of the service in minutes. See range interpretation rules under durationMax.

durationMaxinteger(int32)

Maximum duration (in minutes) when using a duration range. Range interpretation rules:

  • Exact: duration == durationMax\n

  • Starts At: durationMax == null (only minimum known)\n

  • Range: duration < durationMax (both known and different)\n

  • Not Interpreted: duration is null (minimum unknown)\n

Validation: if provided, durationMax must be a non-negative integer and greater than or equal to duration.

curl -i -X POST \
  https://uberall.com/api/service-items \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "price": 0,
    "currency": "USD",
    "category": 0,
    "country": "string",
    "googleService": "string",
    "priceMax": 0,
    "url": "string",
    "duration": 0,
    "durationMax": 0
  }'

Responses

Service Item successfully created

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
application/json
{ "status": "SUCCESS", "message": "string", "warnings": [ "string" ], "response": {} }

Get a Service Item

Request

Get a single service item

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique ID for the service item

curl -i -X GET \
  'https://uberall.com/api/service-items/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Service Item 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

The actual response object of the response

Response
No content

Suggestions

Locations Hub - Locations - Suggestions

Operations

Locations

Locations

Operations