Read a menu from your backend

Read one of the restaurant's published menus from your server, with prices, sizes, choices, availability, your product ids and the menu's version, to keep your own catalog in step with Tamr.

GET/api/v1/catalog/menuServer API · secret key

One published menu, for a backend that keeps Tamr as the source of truth for its menu and prices. The dishes are exactly what Get the menu gives your app at that branch and mode: prices in minor units, sizes, choices, what is on sale now on the branch's clock, and your ids, a branch's own winning over the chain-wide one. With them, the menu's menuId, menuSlug, the service modes it covers, and its version.

  • Name a branch and a mode for the menu the waiter serves there, or a menu by its id or slug (with a branch, the dishes are read at that branch). With neither, the restaurant's default menu.
  • version grows by one each time what diners see on the menu changes, and the menu.changed webhook carries it. Your ids and a sold-out dish coming back on sale don't move it: menu.changed still tells you.
  • The answer carries an ETag. Send it back in If-None-Match and Tamr answers 304 Not Modified with no body while nothing changed. See Keep your app in step.

The dishes exactly as GET /api/v1/menu lists them at that branch and mode, with the menu's ids and the version Tamr recorded. Send the ETag back in If-None-Match to get a 304 when nothing changed.

Authentication

Server API. Send a secret API key with the Menu read (SDK) permission (catalog:read) as Authorization: Bearer <key>. Secret keys are made in Settings > API keys by an owner or admin. Keep them on your server: no browser can call this route.

Query parameters

NameTypeRequiredDescription
branchstringNoAn address: lower-case letters, digits and dashes.
modestringNoOne of dine_in, pickup, delivery.
menustringNo1 to 200 characters.

Response

A CatalogMenuResponse.

FieldTypeDescription
menuobject
menu.menuIdstring1 to 200 characters.
menu.menuSlugstring1 to 200 characters.
menu.namestring1 to 200 characters.
menu.localestringA language tag, such as ar or en-GB.
menu.currencystringA three-letter currency code (ISO 4217).
menu.modesarray of stringAt most 3 items. Each: One of dine_in, pickup, delivery.
menu.branchstring or nullAn address: lower-case letters, digits and dashes.
menu.versioninteger0 to 9,007,199,254,740,991.
menu.updatedAtstring (date-time)
categoriesarray of object
categories[].namestring1 to 200 characters.
categories[].dishesarray of object
categories[].dishes[].dishIdstring1 to 200 characters.
categories[].dishes[].namestring1 to 200 characters.
categories[].dishes[].pricestringAn amount in minor units, as a string.
categories[].dishes[].currencystringA three-letter currency code (ISO 4217).
categories[].dishes[].imageUrlstring or nullMatches ^https:\/\/[^\s]+$.
categories[].dishes[].caloriesinteger or null0 to 9,007,199,254,740,991.
categories[].dishes[].proteinGramsinteger or null0 to 9,007,199,254,740,991.
categories[].dishes[].carbsGramsinteger or null0 to 9,007,199,254,740,991.
categories[].dishes[].fatGramsinteger or null0 to 9,007,199,254,740,991.
categories[].dishes[].allergensarray of stringAt most 10 items. Each: One of gluten, dairy, egg, nuts, sesame, soy, fish, shellfish, peanut, mustard.
categories[].dishes[].dietaryTagsarray of stringAt most 11 items. Each: One of vegan, vegetarian, gluten_free, halal, kosher, dairy_free, nut_free, keto, spicy, high_protein, other. An open list: read a value you don't know as other.
categories[].dishes[].availableboolean
categories[].dishes[].externalIdstring or null1 to 200 characters.
categories[].dishes[].descriptionstring or nullAt most 2,000 characters.
categories[].dishes[].sizesarray of object
categories[].dishes[].choicesarray of object

The ETag response header: The menu's version and a hash of the body. Send it back in If-None-Match: the answer is then a 304 with no body while nothing changed.

Example

curl "https://tamr.link/api/v1/catalog/menu?branch=achrafieh&mode=delivery" \
  -H "Authorization: Bearer $TAMR_SECRET_KEY"

Example response

{
  "menu": {
    "menuId": "cmmenu0001",
    "menuSlug": "dinner",
    "name": "Dinner",
    "locale": "en",
    "currency": "USD",
    "modes": [
      "dine_in",
      "pickup",
      "delivery"
    ],
    "branch": "achrafieh",
    "version": 42,
    "updatedAt": "2026-11-16T09:30:00.000Z"
  },
  "categories": [
    {
      "name": "Mezze",
      "dishes": [
        {
          "dishId": "cmdish0001",
          "name": "Grilled halloumi",
          "price": "1200",
          "currency": "USD",
          "imageUrl": "https://tamr.link/image-proxy/media/halloumi.webp",
          "calories": 420,
          "proteinGrams": 24,
          "carbsGrams": 8,
          "fatGrams": 31,
          "allergens": [
            "dairy"
          ],
          "dietaryTags": [
            "vegetarian"
          ],
          "available": true,
          "externalId": "SKU-HALLOUMI",
          "description": "Grilled, with za'atar.",
          "sizes": [
            {
              "variantId": "9b1c2d3e-0001",
              "label": "Large",
              "price": "1600",
              "externalId": null
            }
          ],
          "choices": [
            {
              "name": "Sauce",
              "min": 0,
              "max": 1,
              "options": [
                {
                  "optionId": "9b1c2d3e-0002",
                  "name": "Garlic",
                  "price": null,
                  "extra": "150",
                  "calories": 90,
                  "proteinGrams": 1,
                  "carbsGrams": 2,
                  "fatGrams": 9,
                  "allergens": [],
                  "externalId": null
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Errors

Every error has the same body; switch on data.code. See Errors and rate limits.

data.codeStatusWhat to do
other401No secret key, or one Tamr doesn't accept: wrong, revoked, or made by someone who is no longer an owner or admin.
other403The key doesn't have the catalog:read permission.
invalid_request400A field doesn't match the spec. The message says which.
rate_limited429Wait retryAfter seconds (also in the Retry-After header), then try again.
sdk_disabled403The SDK isn't switched on for this restaurant. Ask Tamr.
menu_unavailable404No published menu is served at that branch and service mode.