Team account

Register this device for push notifications

Send it after sign-in and whenever the push token changes. Used for the team and guest apps.

Body

platform*

string · one of: ios, android, macos, windows, linux, web

push_token

string | null · max length 512

name

string | null · max length 120

app_version

string | null · max length 40

Who is signed in, and every restaurant they work at with their role and plan

Change name or email. A new email has to be confirmed again

Body

name

string · max length 255

email

string (email) · max length 255

Delete this account

An owner's restaurant accounts are closed too: billing stops and booking pages go offline.

Parameters

password*query

string

The language of the dashboard, emails and API messages

Body

locale*

string · one of: en, el

Change password. Signs out every other device

Body

current_password*

string

password*

string

password_confirmation*

string

Create a restaurant

The first one starts the account and its free trial (or a running sign-up `offer`, such as `starter-2-months`). Later ones add a venue to the account the user owns.

Body

name*

string · max length 120

cuisine

string | null · max length 80

city

string | null · max length 80

address

string | null · max length 160

phone

string | null · max length 30

email

string | null (email) · max length 160

covers

integer | null · min 4 · max 500

timezone

string | null

currency

string | null · one of: EUR, GBP, USD, CHF,

offer

string | null · max length 60

Create (or open) this account's developer sandbox

A demo restaurant with every module and test data, never billed and kept out of the directory. Use it to build against the API: create integration keys with `POST /restaurants/{id}/settings/api-keys`. One sandbox per account.

Devices signed in to this account (one token each)

Sign out one device

Parameters

token*path

integer

Two-factor status

Start turning on two-factor

Returns the secret, an `otpauth://` link and a QR code (SVG) for the authenticator app. Then confirm with a code from the app.

Turn off two-factor. HQ admins must keep it on

Parameters

password*query

string

Finish turning on two-factor. Returns the recovery codes, shown only this once

Body

code*

string · max length 12

New recovery codes. The old ones stop working