Skip to content

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

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

Get All Content Lists

Request

Get all content lists managed by the current API user

Security
accessToken or privateKey
curl -i -X GET \
  https://docs.uberall.com/_mock/apis/swagger/content-lists \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Content lists 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.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​totalinteger(int32)

Total count of results

Example: 100
response.​totalLocationsCountinteger(int32)

Total count of locations

Example: 100
response.​contentListsArray of objects(ContentList)
Response
No content

Create a Content List

Request

Create a content list

Security
accessToken or privateKey
Bodyapplication/jsonrequired

A ContentList object

Array [
idinteger(int64)

Content List id

titlestring

The name of the content list: e.g. 'Lunch Menu'

Example: "Lunch Menu"
typestring

The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or CUSTOM. The type cannot be updated after creation.

Enum"MENU""PEOPLE""PRODUCTS""CUSTOM""SERVICES""EVENTS"
descriptionstring

A description of the content list (section)

translationsobject

Content List Translations Details

Example: {"hu":{"title":"Magyar"},"fr":{"title":"Titre Français"}}
itemsArray of objects(MenuItem)
]
curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/content-lists \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[
    {
      "id": 0,
      "title": "Lunch Menu",
      "type": "MENU",
      "description": "string",
      "translations": {
        "hu": {
          "title": "Magyar"
        },
        "fr": {
          "title": "Titre Français"
        }
      },
      "items": [
        {
          "title": "string",
          "description": "string",
          "identifier": "string",
          "listName": "string",
          "id": 0,
          "price": 0,
          "currency": "EUR",
          "category": "Starters, Drinks, Desert, etc.",
          "image": {
            "id": 0,
            "url": "string",
            "type": "LOGO",
            "description": "string",
            "uid": "string"
          },
          "url": "string",
          "priceMax": 0,
          "caloriesLow": 0,
          "caloriesHigh": 0,
          "allergens": "Eggs, Dairy, Wheat, etc.",
          "dietaryRestrictions": "Vegetarian, Halal, etc."
        }
      ]
    }
  ]'

Responses

Content List successfully created

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

Content List

Response
No content

Get a Content List

Request

Get a content list identified by its uberall unique id

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique id of the content list

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/content-lists/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Content list 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.​contentListobject

Content List

Response
No content

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