Skip to content
Table BuddyTable BuddyRestaurant platform
Sign inGet started
API referenceMenu

List menu categories

Try it

Lists the menu's categories in id order.

GEThttps://tablebuddy.radioworkflow.com/api/v1/menu/categories
Read

Paged in id order: send next_cursor back as cursor for the next page. Categories hidden from the POS are listed too (is_active false). A category synced from Toast keeps Toast's name. See Pagination.

Authentication

Key
Authorization: Bearer <key>, or the same key in x-api-key. A key acts as the person who made it, cut down to this endpoint’s scope, and never as an owner. How keys work
Scope
menu:readRead the menu
The key's creator needs
Take orders on the POS (pos.use) or Edit the menu (menu.manage)

Request headers

Authorizationrequired
Bearer <key>. x-api-key: <key> works too; Authorization wins when both are sent.
Idempotency-Keyignored
Ignored: a read changes nothing, so there is nothing to repeat. Idempotency

Query parameters

limitinteger1–100optional
Rows per page, 1 to 100.

Default 50.

cursorstringidoptional
next_cursor from the previous page.

Any other parameter, or one sent twice, is answered 422 invalid_request naming it. A list pages by cursor: see Pagination.

Response

200OK

In id order. sort_order is the menu's own order.

Text in this answer can be typed in another system the restaurant uses (Toast) and synced in.

currencystringISO 4217
The restaurant's currency: every amount in this answer is in its minor units.
minor_digitsinteger0–3
Digits after the point when an amount is shown: 2 for USD (cents), 0 for JPY.
dataarray of object
This page's rows, in the list's order.
data[].idstringid
The category's id.
data[].namestring
Its name: typed here, or synced from Toast for a Toast menu.
data[].is_activeboolean
Whether it shows on the menu.
data[].sort_orderinteger
Its place on the menu: lower first.
has_moreboolean
Whether another page follows.
next_cursorstringidnullable
The cursor for the next page: send it as cursor. Null on the last page.

An answer may gain fields within v1: ignore the ones you do not know. Versioning

Response headers

request-idalways
This request’s id. Quote it when asking for help.
Cache-Controlalways
no-store: an answer is never cached.
RateLimit-Limit, RateLimit-Remaining, RateLimit-Resetonce the key is known
The key’s units a minute, what is left of this minute’s, and the seconds until the window starts again. Never on a 401. Rate limits
x-error-codeon an error
The error’s code, the same as error.code in the body.
Retry-Afteron a 429
Seconds to wait before sending the same request again.
WWW-Authenticateon a 401, and a 403 insufficient_scope
The Bearer challenge, naming what was wrong with the key or the scope it lacks.

Errors

403insufficient_scope
The key does not carry the endpoint's scope.

Fix: Scopes are fixed when a key is made: make a new key with the scope.

403issuer_access_ended
The key's creator has left the restaurant, was suspended, or was removed and invited back.

Fix: Make a new key from an active account.

403issuer_permission_changed
The key's creator no longer holds any permission that could put this scope on a key.

Fix: Ask an owner to restore the permission, or make a new key from an account that holds it.

403permission_required
The key's permissions for this endpoint (its creator's, cut down to the endpoint's scope) do not include what this endpoint, or this argument, needs. The message names it.

Fix: Use a key with the named scope, from a creator who holds the named permission.

422invalid_request
The request does not match the endpoint's published schema: a missing or unknown field or query parameter, a value out of range. The message names the first four problems.

Fix: Fix the named fields. Nothing was done, and an Idempotency-Key is not used up.

422invalid_cursor
The cursor is not a category of this restaurant.

Fix: Start without cursor.

Possible on every endpoint
401missing_api_keyNo Authorization: Bearer header and no x-api-key header.
401invalid_api_keyThe key is unknown, revoked or expired (answered alike).
429rate_limitedOver the key's 60 units a minute, or over 30 unknown keys a minute from one network (an address; an IPv6 caller's /64).
500internal_errorSomething failed on our side. Nothing kept the Idempotency-Key.

Every code, and when to retry

Request
curl -X GET "$TABLEBUDDY_URL/api/v1/menu/categories?limit=50" \
  -H "Authorization: Bearer $TABLEBUDDY_API_KEY"
Response200
{
  "currency": "USD",
  "minor_digits": 2,
  "data": [
    {
      "id": "cmg5x2b4f0001tb2jx0v5n3ps",
      "name": "Entrées",
      "is_active": true,
      "sort_order": 2
    }
  ],
  "has_more": false,
  "next_cursor": null
}