Get Status
Statuses can be thought of as labels that indicate the current state or progress of a booking, helping users track and manage bookings by categorizing them based on their workflow stage. Examples include “Confirmed,” “Tentative,” “Cancelled,” or custom statuses designed to suit your organization’s needs.
Booking statuses are essential for organizing schedules, as they visually distinguish bookings and can trigger specific actions like sending notifications or updating workflows.
READ
access to the ADMIN
module is required to access this endpointAuthorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
One or more (comma seperated) IDs of statuses to retrieve
Perform a full text search for the status name
Perform a full text search for the status description
Comma seperated list of fields you wish to return
Specify the page of results you wish to return
The number of results returned per page. Default if not specified is 10
Specify the field (with type of string or integer) you wish to order (ascending) the response with
Specify the field (with type of string or integer) you wish to order (descending) the response with
Specify if multiple filters should be combined with OR or AND logic
OR
, AND