Sign in

v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Collection Management

Get a Collection

Retrieve a specific Collection by id

get/collections/{id}

Path parameters

idstring required

The uberall unique id of the Collection to retrieve

Response

Collection found

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "collection": {
      "contentLists": [
        {
          "title": "Lunch Menu",
          "items": [
            {
              "category": "Starters, Drinks, Desert, etc."
            }
          ]
        }
      ]
    }
  }
}