Skip to main content
GET
List reservation statuses
These ids are what Update a Reservation accepts as status, and their codes are what a reservation’s status field carries.

Authorizations

Authorization
string
header
required

Your API key. See Authorization to create one.

Path Parameters

venueId
string
required

The venue being addressed. Every endpoint on this API is venue-scoped.

Minimum string length: 1
Example:

"6247"

Response

The venue's enabled statuses, in display order.

id
string
required

The status's own id. Several statuses can share one code, so this is what distinguishes them.

Example:

"status_seated_main"

name
string
required
Example:

"Seated - Main"

code
enum<string>

The same code a reservation's status carries — the join between the two.

Available options:
U,
P$,
C,
X,
NS,
S,
F,
SP,
TX
statusType
string

A finer-grained state than code.

Example:

"seated"

hide
boolean

The venue keeps this status out of its own status picker. A reservation can still be in it.

order
integer

Venue-defined display order.