Get Bookings
Bookings can be understood as time-based events (with start and end dates / times), which are typically represented on a calendar.
Bookings include details about the event’s timing, the resources being used, and additional information such as the client, associated project, rate details, and any custom attributes defined through custom fields.
READ
access to the SCHEDULE
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 booking's to retrieve
Perform a full text search for the booking name
Specify one or more resource ids and return only the bookings that have these as resources
Specify one or more resource ids and return only the bookings that have these as resources
Specify one or more project ids and return only the bookings are booked to thes projects
Return any bookings starting after the given UNIX timestamp
Return any bookings starting before the given UNIX timestamp
The resources object will contain icon information for each resource
The resources object will contain rates data for each resource relatd to the current booking
The resources object will contain the name of the parent of the resource
When set to true
, only return bookings that include all the specified resource_ids
. If false
(default), bookings will be returned if they include any of the specified resource_ids
.
When set to true
, time entries will be output within each of the the relevant booking resource objects
Return results that were added, edited or deleted since this UNIX timestamp
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
Response
Successful Operation
The response is of type object
.