API reference

Restaurant app

Everything in the Revotab dashboard, for one restaurant: today, bookings, the floor plan, guests, waitlist, loyalty, vouchers, orders, menu, reviews, campaigns, emails, insights, team, settings and billing. Team tokens and API keys.

108 endpoints under https://revotab.com/api/v1/restaurants/{restaurant} · how answers look · errors

Availability

GET/restaurants/{restaurant}/availability Token

Staff view of free times, ignoring online-only rules like cutoff and booking window

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
date*query: string (date)
party*query: integer
ignorequery: integer | null

Billing

GET/restaurants/{restaurant}/billing Token

Billing

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
checkoutquery: string

POST/restaurants/{restaurant}/billing/cancel Token

Billing cancel

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/billing/details Token

Billing details

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

billing_name*: string · max length 160
billing_reg_code: string | null · max length 40
billing_vat_number: string | null · max length 20
billing_address*: string · max length 200
billing_postal_code: string | null · max length 20
billing_city*: string · max length 80
billing_country*: string · one of: AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GR, HR, HU, IE, IT, LT, LU, LV, MT, NL, PL, PT, RO, SE, SI, SK, GB, CH, NO, US, AL, TR, RS, MK, UA, AE, CA, AU · min length 2 · max length 2
billing_email: string | null (email) · max length 160

GET/restaurants/{restaurant}/billing/invoices/{invoice} Token

One of the organisation's own invoices, as PDF

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
invoice*path: integer · The invoice ID

POST/restaurants/{restaurant}/billing/plan Token

Billing choose

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

plan*: string · one of: starter, pro, premium

POST/restaurants/{restaurant}/billing/portal Token

Billing portal

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/billing/resume Token

Billing resume

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Campaigns

GET/restaurants/{restaurant}/campaigns Token

Campaigns

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/campaigns Token

Create campaigns

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

GET/restaurants/{restaurant}/campaigns/audience Token

Campaigns audience

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
channelquery: string

PUT/restaurants/{restaurant}/campaigns/{campaign} Token

Update campaigns

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
campaign*path: integer · The campaign ID

DELETE/restaurants/{restaurant}/campaigns/{campaign} Token

Delete campaigns

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
campaign*path: integer · The campaign ID

POST/restaurants/{restaurant}/campaigns/{campaign}/send Token

Campaigns send

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
campaign*path: integer · The campaign ID

Body

scheduled_at: string | null (date-time)

Changes

GET/restaurants/{restaurant}/changes Token

What changed since the last check

Apps call this every few seconds (or when a push arrives) with the `server_time` from the previous answer as `since`. Lists bookings, waitlist entries, orders and reviews created or changed after it (at most 500 of each). Without `since`: the last 5 minutes.

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
sincequery: string | null (date-time)

Closures

POST/restaurants/{restaurant}/closures Token

Create closures

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

starts_on*: string (date-time)
ends_on*: string (date-time)
shift_id: integer | null
reason: string | null · max length 120

DELETE/restaurants/{restaurant}/closures/{closure} Token

Delete closures

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
closure*path: integer · The closure ID

Dashboard

GET/restaurants/{restaurant}/dashboard Token

Dashboard

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Emails

GET/restaurants/{restaurant}/emails Token

Emails

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/emails/alerts Token

Emails alerts

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

email: string | null · max length 300
new_booking: boolean
cancellation: boolean
new_order: boolean
voucher_sold: boolean

PUT/restaurants/{restaurant}/emails/{key} Token

Update emails

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
key*path: string

DELETE/restaurants/{restaurant}/emails/{key} Token

Emails reset

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
key*path: string
locale*query: string

POST/restaurants/{restaurant}/emails/{key}/preview Token

Emails preview

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
key*path: string

POST/restaurants/{restaurant}/emails/{key}/test Token

Emails test

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
key*path: string

Floor Plan

GET/restaurants/{restaurant}/floor-plan Token

Floor

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/floor-plan/layout Token

Saves positions after dragging tables around the editor

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

tables*: object[] · at least 1

POST/restaurants/{restaurant}/floor-plan/rooms Token

Create floor rooms

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

name*: string · max length 60

PUT/restaurants/{restaurant}/floor-plan/rooms/{room} Token

Update floor rooms

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
room*path: integer · The room ID

Body

name*: string · max length 60
width: integer | null · min 300 · max 3000
height: integer | null · min 300 · max 3000

DELETE/restaurants/{restaurant}/floor-plan/rooms/{room} Token

Delete floor rooms

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
room*path: integer · The room ID

POST/restaurants/{restaurant}/floor-plan/tables Token

Create floor tables

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/floor-plan/tables/{table} Token

Update floor tables

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
table*path: integer · The table ID

DELETE/restaurants/{restaurant}/floor-plan/tables/{table} Token

Delete floor tables

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
table*path: integer · The table ID

Guests

GET/restaurants/{restaurant}/guests Token

Guests

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/guests Token

Create guests

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

GET/restaurants/{restaurant}/guests/export Token

Guests export

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

GET/restaurants/{restaurant}/guests/search Token

Typeahead for the booking form

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

GET/restaurants/{restaurant}/guests/{guest} Token

Get guests

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
guest*path: integer · The guest ID

PUT/restaurants/{restaurant}/guests/{guest} Token

Update guests

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
guest*path: integer · The guest ID

DELETE/restaurants/{restaurant}/guests/{guest} Token

Delete guests

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
guest*path: integer · The guest ID

POST/restaurants/{restaurant}/guests/{guest}/loyalty Token

From a guest's profile: give them a card and email them its link

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
guest*path: integer · The guest ID

Insights

GET/restaurants/{restaurant}/insights Token

Insights

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Loyalty

GET/restaurants/{restaurant}/loyalty Token

Loyalty

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/loyalty Token

Update loyalty

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

enabled: boolean
target*: integer · min 3 · max 20
reward*: string · max length 80
earn_visits: boolean
earn_orders: boolean
welcome_stamp: boolean

POST/restaurants/{restaurant}/loyalty/cards/{card}/redeem Token

Loyalty redeem

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
card*path: integer · The card ID

POST/restaurants/{restaurant}/loyalty/cards/{card}/stamp Token

Loyalty stamp

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
card*path: integer · The card ID

Body

key: string | null (uuid)

POST/restaurants/{restaurant}/loyalty/cards/{card}/unstamp Token

Loyalty unstamp

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
card*path: integer · The card ID

POST/restaurants/{restaurant}/loyalty/lookup Token

Scanner and search: find a card of this restaurant by its link or token

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

code*: string · max length 300

Messages

GET/restaurants/{restaurant}/messages Token

Messages

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Orders

GET/restaurants/{restaurant}/orders Token

Orders

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/orders/{order}/status Token

Orders status

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
order*path: integer · The order ID

Body

status*: string · one of: new, accepted, ready, collected, cancelled

Reservations

GET/restaurants/{restaurant}/reservations Token

Reservations

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
datequery: string
statusquery: string
qquery: string

POST/restaurants/{restaurant}/reservations Token

Create reservations

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

date*: string (date)
time*: string
party_size*: integer · min 1 · max 200
duration: integer | null · min 15 · max 600
guest_id: integer | null
first_name: string | null · max length 80
last_name: string | null · max length 80
email: string | null (email) · max length 160
phone: string | null · max length 30
occasion: string | null · max length 40
guest_notes: string | null · max length 1000
staff_notes: string | null · max length 1000
source*: string · one of: phone, walk_in, staff, email
table_ids: array | null
force: boolean
notify: boolean

PUT/restaurants/{restaurant}/reservations/{reservation} Token

Update reservations

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
reservation*path: integer · The reservation ID

Body

date*: string (date)
time*: string
party_size*: integer · min 1 · max 200
duration*: integer · min 15 · max 600
occasion: string | null · max length 40
guest_notes: string | null · max length 1000
staff_notes: string | null · max length 1000
bill_amount: number | null · min 0

POST/restaurants/{restaurant}/reservations/{reservation}/review Token

Reservations review

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
reservation*path: integer · The reservation ID

POST/restaurants/{restaurant}/reservations/{reservation}/status Token

Reservations status

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
reservation*path: integer · The reservation ID

Body

status*: string · one of: pending, confirmed, seated, completed, cancelled, no_show

POST/restaurants/{restaurant}/reservations/{reservation}/tables Token

Reservations tables

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
reservation*path: integer · The reservation ID

Body

table_ids: integer[]

Reviews

GET/restaurants/{restaurant}/reviews Token

Reviews

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
filterquery: string

POST/restaurants/{restaurant}/reviews/{review}/reply Token

Reviews reply

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
review*path: integer · The review ID

Body

reply*: string · max length 2000

POST/restaurants/{restaurant}/reviews/{review}/toggle Token

Reviews toggle

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
review*path: integer · The review ID

Service

GET/restaurants/{restaurant}/service Token

Service

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
datequery: string

Services

GET/restaurants/{restaurant}/services Token

Shifts

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/services Token

Create shifts

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/services/{shift} Token

Update shifts

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
shift*path: integer · The shift ID

DELETE/restaurants/{restaurant}/services/{shift} Token

Delete shifts

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
shift*path: integer · The shift ID

Settings

GET/restaurants/{restaurant}/settings Token

Settings

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/settings Token

Update settings

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

restaurant*: object
restaurant.name*: string · max length 120
restaurant.statement_name: string | null · max length 13 · Letters, digits, spaces and . - & only (Stripe rule), at least one letter, short enough to fit.
restaurant.slug*: string · max length 60
restaurant.cuisine: string | null · max length 80
restaurant.price_range*: integer · min 1 · max 4
restaurant.description: string | null · max length 3000
restaurant.email: string | null (email)
restaurant.phone: string | null · max length 30
restaurant.website: string | null (uri)
restaurant.address: string | null · max length 160
restaurant.city: string | null · max length 80
restaurant.postal_code: string | null · max length 20
restaurant.country*: string · min length 2 · max length 2
restaurant.timezone*: string
restaurant.currency*: string · one of: EUR, GBP, USD, CHF
restaurant.locale*: string · one of: en, el, fr, de, es, it, nl, pt
restaurant.brand_color*: string
restaurant.is_published: boolean
booking*: object
booking.min_party*: integer · min 1
booking.max_party*: integer · max 100
booking.booking_window_days*: integer · min 1 · max 365
booking.cutoff_minutes*: integer · min 0 · max 2880
booking.auto_confirm: boolean
booking.cancel_until_hours*: integer · min 0 · max 168
booking.no_show_fee: number | null · min 0
booking.waitlist_enabled: boolean
booking.reminder_hours*: integer · min 0 · max 168
booking.review_delay_hours*: integer · min 0 · max 168
booking.large_party_message: string | null · max length 300
booking.terms: string | null · max length 3000

POST/restaurants/{restaurant}/settings/api-keys Token

New API key. The key itself is shown once, in this answer only

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

name*: string · max length 80
access*: string · one of: read, write

DELETE/restaurants/{restaurant}/settings/api-keys/{key} Token

Delete settings keys

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
key*path: integer

POST/restaurants/{restaurant}/settings/cover Token

Settings cover

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body (multipart/form-data)

cover*: string (binary) · Maximum file size: 6144 kilobytes.

DELETE/restaurants/{restaurant}/settings/cover Token

Delete settings cover

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/settings/token Token

Settings token

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/settings/webhooks Token

New webhook. Its signing secret is shown once, in this answer only

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/settings/webhooks/{webhook} Token

Update settings webhooks

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
webhook*path: integer · The webhook ID

DELETE/restaurants/{restaurant}/settings/webhooks/{webhook} Token

Delete settings webhooks

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
webhook*path: integer · The webhook ID

GET/restaurants/{restaurant}/settings/webhooks/{webhook}/deliveries Token

The last 50 deliveries of one webhook, newest first

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
webhook*path: integer · The webhook ID

POST/restaurants/{restaurant}/settings/webhooks/{webhook}/test Token

Send a test event ("ping") to the webhook now

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
webhook*path: integer · The webhook ID

PUT/restaurants/{restaurant}/settings/widget Token

Settings widget

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

launcher*: object
launcher.enabled*: boolean
launcher.style*: string · one of: pill, rounded, square, icon
launcher.position*: string · one of: left, right
launcher.icon*: string · one of: calendar, utensils, bell, none
launcher.label: object
launcher.label.en*: string · max length 32
launcher.label.el: string | null · max length 32
launcher.color: string | null
launcher.text_color: string | null
launcher.offset*: integer · min 0 · max 120
launcher.mobile*: boolean
open*: object
open.desktop*: string · one of: panel, modal
theme*: object
theme.radius*: string · one of: sharp, soft, round
theme.mode*: string · one of: light, dark
teaser*: object
teaser.enabled*: boolean
teaser.text: object
teaser.text.en: string | null · max length 90
teaser.text.el: string | null · max length 90
teaser.delay*: integer · min 1 · max 60

POST/restaurants/{restaurant}/settings/widget/check Token

Looks at a page of the restaurant's website and says whether the widget is on it. Only public https:// addresses; the page is read, nothing on it runs

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

url*: string (uri) · max length 300

GET/restaurants/{restaurant}/settings/widget/qr Token

A QR code to the booking page, as SVG, for menus, tables and windows

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Support

GET/restaurants/{restaurant}/support Token

Support

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
filterquery: string

POST/restaurants/{restaurant}/support Token

Create support

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

topic*: string · one of: bookings, setup, billing, account, technical, idea, other
priority*: string · one of: normal, urgent
subject*: string · min length 4 · max length 200
message*: string · min length 10 · max length 5000

GET/restaurants/{restaurant}/support/{ticket} Token

Get support

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
ticket*path: integer · The ticket ID

POST/restaurants/{restaurant}/support/{ticket}/reply Token

Support reply

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
ticket*path: integer · The ticket ID

Body

message*: string · min length 2 · max length 5000

POST/restaurants/{restaurant}/support/{ticket}/solved Token

Support solve

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
ticket*path: integer · The ticket ID

Team

GET/restaurants/{restaurant}/team Token

Team

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

POST/restaurants/{restaurant}/team Token

Adds an existing user, or creates an account and emails a password-setup link

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

name*: string · max length 120
email*: string (email)
role*: string · one of: manager, host, staff

PUT/restaurants/{restaurant}/team/{user} Token

Update team

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
user*path: integer · The user ID

Body

role*: string · one of: manager, host, staff

DELETE/restaurants/{restaurant}/team/{user} Token

Delete team

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
user*path: integer · The user ID

Venues

POST/restaurants/{restaurant}/venues Token

Adds another venue to the owner's group (multi-venue)

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Vouchers

GET/restaurants/{restaurant}/vouchers Token

Vouchers

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
qquery: string

POST/restaurants/{restaurant}/vouchers/issue Token

Issue a voucher by hand (sold at the till, or a goodwill gesture)

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

title*: string · max length 120
value*: number · min 1
buyer_name*: string · max length 120
buyer_email*: string (email)
recipient_name: string | null · max length 120
recipient_email: string | null (email)
message: string | null · max length 500
expires_on: string | null (date-time)
send_email: boolean

POST/restaurants/{restaurant}/vouchers/products Token

Create vouchers products

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

PUT/restaurants/{restaurant}/vouchers/products/{product} Token

Update vouchers products

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
product*path: integer · The product ID

POST/restaurants/{restaurant}/vouchers/{voucher}/cancel Token

Vouchers cancel

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
voucher*path: integer · The voucher ID

POST/restaurants/{restaurant}/vouchers/{voucher}/redeem Token

Vouchers redeem

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
voucher*path: integer · The voucher ID

Body

amount*: number · min 0.01
note: string | null · max length 200

POST/restaurants/{restaurant}/vouchers/{voucher}/refund Token

Full refund of an unused voucher bought online (e.g. within the 14-day withdrawal period)

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
voucher*path: integer · The voucher ID

Waitlist

GET/restaurants/{restaurant}/waitlist Token

Waitlist

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
datequery: string

POST/restaurants/{restaurant}/waitlist Token

Create waitlist

Parameters

restaurant*path: integer · The restaurant id (from GET /me).

Body

date*: string (date)
time: string | null
party_size*: integer · min 1 · max 100
first_name*: string · max length 80
last_name: string | null · max length 80
email: string | null (email)
phone: string | null · max length 30
notes: string | null · max length 500

DELETE/restaurants/{restaurant}/waitlist/{entry} Token

Delete waitlist

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
entry*path: integer · The entry ID

POST/restaurants/{restaurant}/waitlist/{entry}/book Token

Waitlist book

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
entry*path: integer · The entry ID

Body

time*: string

POST/restaurants/{restaurant}/waitlist/{entry}/notify Token

Waitlist notify

Parameters

restaurant*path: integer · The restaurant id (from GET /me).
entry*path: integer · The entry ID

Body

time*: string

* required

Restaurant app

Availability

Billing

Campaigns

Changes

Closures

Dashboard

Emails

Floor Plan

Guests

Insights

Loyalty

Menu

Messages

Orders

Reservations

Reviews

Service

Services

Settings

Support

Team

Venues

Vouchers

Waitlist