GET
/
v2
/
bookings

Headers

cal-api-version
string
required

Must be set to 2024-08-13

Authorization
string
required

value must be Bearer <token> where <token> either managed user access token or api key prefixed with cal_

Query Parameters

status
enum<string>[]

Filter bookings by status. If you want to filter by multiple statuses, separate them with a comma.

Available options:
upcoming,
recurring,
past,
cancelled,
unconfirmed
attendeeEmail
string

Filter bookings by the attendee's email address.

attendeeName
string

Filter bookings by the attendee's name.

eventTypeIds
string

Filter bookings by event type ids belonging to the user. Event type ids must be separated by a comma.

eventTypeId
string

Filter bookings by event type id belonging to the user.

teamsIds
string

Filter bookings by team ids that user is part of. Team ids must be separated by a comma.

teamId
string

Filter bookings by team id that user is part of

afterStart
string

Filter bookings with start after this date string.

beforeEnd
string

Filter bookings with end before this date string.

sortStart
enum<string>

Sort results by their start time in ascending or descending order.

Available options:
asc,
desc
sortEnd
enum<string>

Sort results by their end time in ascending or descending order.

Available options:
asc,
desc
sortCreated
enum<string>

Sort results by their creation time (when booking was made) in ascending or descending order.

Available options:
asc,
desc
take
number

The number of items to return

skip
number

The number of items to skip

Response

200 - application/json
status
enum<string>
required
Available options:
success,
error
data
array
required

Array of booking data, which can contain either BookingOutput objects or RecurringBookingOutput objects

error
object