Skip to main content
GET
Search reservations

Authorizations

Authorization
string
header
default:your_token_here
required

Restaurant-scoped partner API token passed as Authorization: Bearer <token>.

Query Parameters

start_at_from
string<date-time>

Lower inclusive datetime bound for reservation start time filtering.

start_at_to
string<date-time>

Upper inclusive datetime bound for reservation start time filtering.

email
string<email>

Filter reservations by the linked customer email address.

phone
string

Filter reservations by the linked customer phone number.

Minimum string length: 1
status
enum<string>[]

Filter reservations by one or more reservation statuses. Repeat the query parameter to pass multiple values.

Available options:
PENDING,
PENDING_PAYMENT,
CANCELED_BY_USER,
CONFIRMED,
CONFIRMED_PENDING_PAYMENT,
MANUALLY_CONFIRMED,
DOUBLE_CONFIRMED,
REJECTED,
CANCELED_BY_RESTAURANT,
SHOWED_UP,
NO_SHOW,
SEATED,
PARTIALLY_SEATED,
DONE,
SEATED_FOR_DRINKS
external_id
string

Filter reservations by the partner-provided external reference.

Minimum string length: 1
party_size
integer

Filter reservations by party size.

Required range: x >= 1
page
integer
default:1

1-based page number for paginated search results.

Required range: x >= 1
per_page
integer
default:25

Number of reservations returned per page, from 1 to 100.

Required range: 1 <= x <= 100

Response

Reservation search results

data
object[]
required
pagination
object
required