Skip to content
API Reference
/
Collection Management
/
Get a Collection

Uberall API (20250708)

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

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

Create a collection

Request

Create a new collection managed by the current API user. If the user specifies a set of locations for the collections, users managing the whole set of locations can also manage the collection.

Security
X-API-KEY or Authorization
Bodyapplication/json

ContentCollection object to create

idinteger(int64)

Collection id

identifierstringrequired

Mandatory - A unique identifier for the collection

namestringrequired

Mandatory - Name of the content collection

descriptionstring

A description of the collection

typestringrequired

Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM

Enum"MENU""PEOPLE""PRODUCTS""CUSTOM""SERVICES""EVENTS"
contentListsArray of objects(ContentList)

Mandatory - Sections within the content collections

locationIdsArray of integers(int64)unique

Location Ids that should be associated with this collection

isReadOnlyboolean

Special field for FE indicating if the collection is read-only for the logged in user

Example: false
cuisineTypestring

Only applicable to Menu content collections - indicates the cuisine the restaurant serves

Enum"AMERICAN""ASIAN""BRAZILIAN""BREAKFAST""BRUNCH""CHICKEN""CHINESE""FAMILY""FAST_FOOD""FRENCH"
urlstring

Applicable to Menu collections only - url to the brand webpage menu

curl -i -X POST \
  https://uberall.com/api/collections \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "identifier": "string",
    "name": "string",
    "description": "string",
    "type": "MENU",
    "contentLists": [
      {
        "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."
          }
        ]
      }
    ],
    "locationIds": [
      0
    ],
    "isReadOnly": false,
    "cuisineType": "AMERICAN",
    "url": "string"
  }'

Responses

Collection 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.​collectionobject

Content Collection

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "collection": { … }
  }
}

Get a Collection

Request

Retrieve a specific Collection by id

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the Collection to retrieve

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

Responses

Collection found

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

Content Collection

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "collection": { … }
  }
}

Delete a Collection

Request

Delete a specific Collection by id

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the Collection to delete

Bodyapplication/json

ContentCollection object to delete

idinteger(int64)

Collection id

identifierstringrequired

Mandatory - A unique identifier for the collection

namestringrequired

Mandatory - Name of the content collection

descriptionstring

A description of the collection

typestringrequired

Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM

Enum"MENU""PEOPLE""PRODUCTS""CUSTOM""SERVICES""EVENTS"
contentListsArray of objects(ContentList)

Mandatory - Sections within the content collections

locationIdsArray of integers(int64)unique

Location Ids that should be associated with this collection

isReadOnlyboolean

Special field for FE indicating if the collection is read-only for the logged in user

Example: false
cuisineTypestring

Only applicable to Menu content collections - indicates the cuisine the restaurant serves

Enum"AMERICAN""ASIAN""BRAZILIAN""BREAKFAST""BRUNCH""CHICKEN""CHINESE""FAMILY""FAST_FOOD""FRENCH"
urlstring

Applicable to Menu collections only - url to the brand webpage menu

curl -i -X DELETE \
  'https://uberall.com/api/collections/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "identifier": "string",
    "name": "string",
    "description": "string",
    "type": "MENU",
    "contentLists": [
      {
        "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."
          }
        ]
      }
    ],
    "locationIds": [
      0
    ],
    "isReadOnly": false,
    "cuisineType": "AMERICAN",
    "url": "string"
  }'

Responses

Collection deleted

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

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

Suggestions

Locations Hub - Locations - Suggestions

Operations