Skip to content
API Reference/
/
Get all collections

Get all collections

Request

Get all the collections managed by the current API user.

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

Responses

Collections found

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 50,
    "total": 304,
    "totalLocationsCount": 100,
    "collections": [
      {
        "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": [
              {
                "image": {},
                "allergens": [],
                "dietaryRestrictions": []
              }
            ]
          }
        ],
        "locationIds": [
          0
        ],
        "isReadOnly": false,
        "cuisineType": "AMERICAN",
        "url": "string"
      }
    ]
  }
}