Get the waiter

Read the waiter's public face: name, greeting, starters, languages, brand, the restaurant's published app settings and where orders go.

GET/api/v1/waiterClient API

What a custom chat screen needs before the first message: the waiter's name and greeting, starters, languages, the restaurant's brand, its published "Waiter in your app" settings (app) and ordersGoTo (tamr or app_cart), with ordersGoToByMode when the restaurant sends each way of ordering its own way (see Ordering modes). It needs your app key only, no session.

Authentication

Client API. Send your publishable key in x-tamr-key. No session is needed.

Query parameters

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

Response

A WaiterFace.

FieldTypeDescription
namestring1 to 60 characters.
avatarLetterstring1 to 2 characters.
greetingstring1 to 500 characters.
startersarray of stringAt most 8 items. 1 to 80 characters.
voiceboolean
languagesarray of stringAt most 12 items. A language tag, such as ar or en-GB.
brandobjectMay be absent. The restaurant's brand: the menu's kit over the organization's. Every field optional.
brand.accentstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
brand.accentSecondarystringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
brand.paperstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
brand.displayFontstringMay be absent. One of fraunces, cormorant, playfair, dm-serif, eb-garamond, crimson, other. An open list: read a value you don't know as other.
brand.uiFontstringMay be absent. One of geist, inter, system, manrope, sora, dm-sans, other. An open list: read a value you don't know as other.
brand.displayFontUrlstringMay be absent. Matches ^https:\/\/[^\s]+$.
brand.uiFontUrlstringMay be absent. Matches ^https:\/\/[^\s]+$.
brand.logoUrlstringMay be absent. Matches ^https:\/\/[^\s]+$.
ordersGoTostringOne of tamr, app_cart. An open list: read a value you don't know as tamr.
ordersGoToByModeobjectMay be absent. Where orders go for each way of ordering, over ordersGoTo. A way left out goes where ordersGoTo says.
ordersGoToByMode.dine_instringMay be absent. One of tamr, app_cart. An open list: read a value you don't know as tamr.
ordersGoToByMode.pickupstringMay be absent. One of tamr, app_cart. An open list: read a value you don't know as tamr.
ordersGoToByMode.deliverystringMay be absent. One of tamr, app_cart. An open list: read a value you don't know as tamr.
appobjectMay be absent. The restaurant's settings for the waiter in its app, between the menu's brand and the app's overrides. Every field but allowCustomise may be left out.
app.lookobjectMay be absent.
app.look.schemestringMay be absent. One of light, dark, auto. An open list: read a value you don't know as auto.
app.look.accentstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.accentSecondarystringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.paperstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.textstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.displayFontstringMay be absent. One of fraunces, cormorant, playfair, dm-serif, eb-garamond, crimson, other. An open list: read a value you don't know as other.
app.look.uiFontstringMay be absent. One of geist, inter, system, manrope, sora, dm-sans, other. An open list: read a value you don't know as other.
app.look.cornersstringMay be absent. One of round, soft, square. An open list: read a value you don't know as soft.
app.look.headerColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.bubbleColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.buttonColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.cardColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.mutedColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.lineColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.positiveColorstringMay be absent. Matches ^#[0-9a-fA-F]{6}$.
app.look.headerstringMay be absent. One of plain, brand. An open list: read a value you don't know as plain.
app.look.bubblestringMay be absent. One of soft, brand. An open list: read a value you don't know as soft.
app.look.buttonsstringMay be absent. One of pill, rounded, square. An open list: read a value you don't know as pill.
app.look.starterStylestringMay be absent. One of chips, cards. An open list: read a value you don't know as chips.
app.shownobjectMay be absent.
app.shown.showHeaderbooleanMay be absent.
app.shown.showLogobooleanMay be absent.
app.shown.showWaiterNamebooleanMay be absent.
app.shown.showWelcomebooleanMay be absent.
app.shown.showStartersbooleanMay be absent.
app.shown.showQuickRepliesbooleanMay be absent.
app.shown.showNewChatbooleanMay be absent.
app.shown.showCheckoutbooleanMay be absent.
app.shown.showBackbooleanMay be absent.
app.shown.hideVoicebooleanMay be absent.
app.shown.hideReviewsbooleanMay be absent.
app.shown.hideRetailSuggestionsbooleanMay be absent.
app.shown.hideLoyaltybooleanMay be absent.
app.wordingobjectMay be absent.
app.startersobjectMay be absent.
app.allowCustomiseboolean

Example

curl "https://tamr.link/api/v1/waiter?branch=achrafieh" \
  -H "x-tamr-key: $TAMR_APP_KEY"

Example response

{
  "name": "Céline",
  "avatarLetter": "C",
  "ordersGoTo": "tamr",
  "greeting": "Hi! What are you in the mood for?",
  "starters": [
    "What's popular?",
    "Something vegan"
  ],
  "voice": true,
  "languages": []
}

Errors

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

data.codeStatusWhat to do
app_key_invalid401The key is wrong, revoked or of another kind. Check it in the dashboard.
sdk_disabled403The SDK isn't switched on for this restaurant. Ask Tamr.
origin_not_allowed403A browser called from an origin the key doesn't list. Add the origin to the key.
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.
menu_unavailable404No published menu is served at that branch and service mode.