Get organization team bookings

Headers

Authorization

string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-key

string

For platform customers - OAuth client secret key

x-cal-client-id

string

For platform customers - OAuth client ID

Path Parameters

teamId

number

required

orgId

number

required

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 team. Event type ids must be separated by a comma.

eventTypeId

string

Filter bookings by event type id belonging to the team.

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

Required range: 1 <= x <= 250

skip

number

The number of items to skip

Required range: x >= 0

Response

200 - application/json

status

enum<string>

required

Available options:

success,

error

Example:

"success"

data

object[]

required

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

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

data.id

number

required

Example:

123

data.uid

string

required

Example:

"booking_uid_123"

data.title

string

required

Example:

"Consultation"

data.description

string

required

Example:

"Learn how to integrate scheduling into marketplace."

data.hosts

object[]

required

Show child attributes

data.hosts.id

number

required

Example:

1

data.hosts.name

string

required

Example:

"Jane Doe"

data.hosts.email

string

required

Example:

"[e-mail]"

data.hosts.username

string

required

Example:

"jane100"

data.hosts.timeZone

string

required

Example:

"America/Los_Angeles"

data.status

enum<string>

required

Available options:

cancelled,

accepted,

rejected,

pending

Example:

"accepted"

data.start

string

required

Example:

"2024-08-13T15:30:00Z"

data.end

string

required

Example:

"2024-08-13T16:30:00Z"

data.duration

number

required

Example:

60

data.eventTypeId

number

required

deprecated

Deprecated - rely on 'eventType' object containing the id instead.

Example:

50

data.eventType

object

required

Show child attributes

data.eventType.id

number

required

Example:

1

data.eventType.slug

string

required

Example:

"some-event"

data.location

string

required

Example:

"https://example.com/meeting"

data.absentHost

boolean

required

Example:

true

data.createdAt

string

required

Example:

"2024-08-13T15:30:00Z"

data.updatedAt

string

required

Example:

"2024-08-13T15:30:00Z"

data.attendees

object[]

required

Show child attributes

data.attendees.name

string

required

The name of the attendee.

Example:

"John Doe"

data.attendees.timeZone

string

required

The time zone of the attendee.

Example:

"America/New_York"

data.attendees.email

string

The email of the attendee.

Example:

"[e-mail]"

data.attendees.phoneNumber

string

The phone number of the attendee in international format.

Example:

"[phone]"

data.attendees.language

enum<string>

default:en

The preferred language of the attendee. Used for booking confirmation.

Available options:

ar,

ca,

de,

es,

eu,

he,

id,

ja,

lv,

pl,

ro,

sr,

th,

vi,

az,

cs,

el,

es-419,

fi,

hr,

it,

km,

nl,

pt,

ru,

sv,

tr,

zh-CN,

bg,

da,

en,

et,

fr,

hu,

iw,

ko,

no,

pt-BR,

sk,

ta,

uk,

zh-TW

Example:

"it"

data.bookingFieldsResponses

object

required

Booking field responses consisting of an object with booking field slug as keys and user response as values.

Example:

{ "customField": "customValue" }

data.cancellationReason

string

Example:

"User requested cancellation"

data.cancelledByEmail

string

Example:

"[e-mail]"

data.reschedulingReason

string

Example:

"User rescheduled the event"

data.rescheduledByEmail

string

Example:

"[e-mail]"

data.rescheduledFromUid

string

Example:

"previous_uid_123"

data.meetingUrl

string

deprecated

Deprecated - rely on 'location' field instead.

Example:

"https://example.com/recurring-meeting"

data.metadata

object

Example:

{ "key": "value" }

data.rating

number

Example:

4

data.icsUid

string

UID of ICS event.

Example:

"ics_uid_123"

data.guests

string[]

Example:

["[e-mail]", "[e-mail]"]

error

object