# Get all collections

Get all the collections managed by the current API user.

Endpoint: GET /collections
Version: 20250708
Security: X-API-KEY, Authorization

## Response 200 fields (*/*):

  - `status` (string, required)
    Enum: "SUCCESS", "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"

  - `message` (string)
    (optional) Holds further information about the response

  - `warnings` (array)
    (optional) Holds further warnings

  - `response` (object, required)
    The actual response object of the response

  - `response.offset` (integer)
    Offset for pagination

  - `response.max` (integer)
    Maximum number of results per page
    Example: 50

  - `response.total` (integer)
    Total count of results
    Example: 304

  - `response.totalLocationsCount` (integer)
    Total count of locations
    Example: 100

  - `response.collections` (array)
    Content Collection List

  - `response.collections.id` (integer)
    Collection id

  - `response.collections.identifier` (string, required)
    Mandatory - A unique identifier for the collection

  - `response.collections.name` (string, required)
    Mandatory - Name of the content collection

  - `response.collections.description` (string)
    A description of the collection

  - `response.collections.type` (string, required)
    Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM
    Enum: "MENU", "PEOPLE", "PRODUCTS", "CUSTOM", "SERVICES", "EVENTS"

  - `response.collections.contentLists` (array)
    Mandatory - Sections within the content collections

  - `response.collections.contentLists.id` (integer)
    Content List id

  - `response.collections.contentLists.title` (string)
    The name of the content list: e.g. 'Lunch Menu'
    Example: "Lunch Menu"

  - `response.collections.contentLists.type` (string)
    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"

  - `response.collections.contentLists.description` (string)
    A description of the content list (section)

  - `response.collections.contentLists.translations` (object)
    Language translations for the section title of a content collection
    Example: {"hu":{"title":"Magyar"},"fr":{"title":"Titre Français"}}

  - `response.collections.contentLists.translations.locale` (object)
    Content List Translation

  - `response.collections.contentLists.translations.locale.field` (string)
    The field for translation
    Enum: "TITLE"

  - `response.collections.contentLists.items` (array)

  - `response.collections.contentLists.items.title` (string, required)
    Title

  - `response.collections.contentLists.items.description` (string)
    Description of the menu item: e.g. 'With mozzarella, fresh basil and tomatoes'

  - `response.collections.contentLists.items.identifier` (string)
    Unique Identifier for the Menu

  - `response.collections.contentLists.items.listName` (string)

  - `response.collections.contentLists.items.id` (integer)
    The uberall unique id for the menu item

  - `response.collections.contentLists.items.price` (integer)
    Price of the menu item in cents: e.g. '1500' for 15 €

  - `response.collections.contentLists.items.currency` (string)
    Currency used for prices in ISO-4217: e.g. EUR, USD, CHF
    Enum: "EUR", "USD", "GBP", "CHF", "AUD", "RUB", "JPY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"

  - `response.collections.contentLists.items.category` (string)
    Category or section of the menu item (e.g. Starters, Drinks, Desert, etc.)
    Example: "Starters, Drinks, Desert, etc."

  - `response.collections.contentLists.items.image` (object)
    Image of the menu (use the Image object format)

  - `response.collections.contentLists.items.image.id` (integer)
    The uberall unique id for the image

  - `response.collections.contentLists.items.image.url` (string, required)
    Image url

  - `response.collections.contentLists.items.image.type` (string, required)
    The image type, one of [LOGO, MAIN, IMAGE]
    Enum: "LOGO", "MAIN", "IMAGE"

  - `response.collections.contentLists.items.image.description` (string)
    Description of the image

  - `response.collections.contentLists.items.image.uid` (string, required)
    user identifier of the image

  - `response.collections.contentLists.items.url` (string)
    A valid page url with more details about the item

  - `response.collections.contentLists.items.priceMax` (integer)
    Maximum price if you want to use a price range for the item

  - `response.collections.contentLists.items.caloriesLow` (integer)
    The lowest possible number of calories for a menu item

  - `response.collections.contentLists.items.caloriesHigh` (integer)
    The high end of the range of calories for a menu item

  - `response.collections.contentLists.items.allergens` (array)
    Allergens in the food item (e.g. Eggs, Dairy, Wheat, etc.)
    Example: "Eggs, Dairy, Wheat, etc."

  - `response.collections.contentLists.items.dietaryRestrictions` (array)
    Restrictive diet the menu item fits into (e.g. Vegetarian, Halal, etc.)
    Example: "Vegetarian, Halal, etc."

  - `response.collections.locationIds` (array)
    Location Ids that should be associated with this collection

  - `response.collections.isReadOnly` (boolean)
    Special field for FE indicating if the collection is read-only for the logged in user

  - `response.collections.cuisineType` (string)
    Only applicable to Menu content collections - indicates the cuisine the restaurant serves
    Enum: "AMERICAN", "ASIAN", "BRAZILIAN", "BREAKFAST", "BRUNCH", "CHICKEN", "CHINESE", "FAMILY", "FAST_FOOD", "FRENCH", "GREEK", "GERMAN", "HAMBURGER", "INDIAN", "INDONESIAN", "ITALIAN", "JAPANESE", "KOREAN", "LATIN_AMERICAN", "MEDITERRANEAN", "MEXICAN", "PAKISTANI", "PIZZA", "SEAFOOD", "SPANISH", "SUSHI", "THAI", "TURKISH", "VEGETARIAN", "VIETNAMESE", "OTHER_CUISINE"

  - `response.collections.url` (string)
    Applicable to Menu collections only - url to the brand webpage menu

## Response 400 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "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"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 401 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "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"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 403 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "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"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 404 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "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"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response