v1

latestOpenAPI 3.0.02026-07-1498671635.3 KB
Restaurants
publicly-accessible

Get all categories

Get all categories on the restaurant's menu

get/restaurants/{tenant}/{restaurantId}/catalogue/categories

Path parameters

tenantstring required

Request tenant.

restaurantIdstring required

The restaurant Id.

Query parameters

limitinteger required

The maximum number of categories to fetch.

afterstring

Value representing a cursor - position to use when retrieving the next page of data. If provided, the value of this parameter must be URL encoded.

Response

Request succeeded.

Example response

{
  "categories": [
    {
      "description": "Sumptuous starters",
      "id": "3",
      "name": "Starters"
    },
    {
      "description": "Magnificent mains",
      "id": "4",
      "name": "Mains"
    }
  ],
  "paging": {
    "cursors": {
      "after": "NDMyNzQyODI3OTQw"
    }
  }
}