Skip to main content
GET
List booking statuses

Authorizations

Authorization
string
header
required

Bearer authentication using your BookingShake API key. Retrieve your API key from Settings > Integrations in your BookingShake dashboard.

Response

List of booking statuses retrieved successfully

value
string

Status ID

Example:

"Zx8Kp3Qm7nRt"

label
string

Status display name (may be in French or configured language)

Example:

"Confirmé"

type
enum<string> | null

Semantic status type. Use it instead of hardcoding venue-specific status IDs.

Available options:
new,
validated,
done,
pseudo_done,
canceled,
archived,
null
Example:

"validated"

is_canceled
boolean

True when this status means the booking is cancelled (type 'canceled' or venue-flagged as cancelled)

Example:

false

color
string | null

Hex color configured for the status

Example:

"#4CAF50"

order
integer | null

Display order

Example:

2

scope
string | null

Status scope: 'event'/'booking' statuses apply to bookings; 'task'/'task_tag' entries belong to task boards and should be filtered out by most integrations

Example:

"booking"