Get a booking
Changed on:bookingUid can be
1. uid of a normal booking
2. uid of one of the recurring booking recurrences
3. uid of recurring booking which will return an array of all recurring booking recurrences (stored as recurringBookingUid on one of the individual recurrences).
If you are fetching a seated booking for an event type with 'show attendees' disabled, then to retrieve attendees in the response either set 'show attendees' to true on event type level or
you have to provide an authentication method of event type owner, host, team admin or owner or org admin or owner.
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
Request
- The document declares no server URL.
- Authnone declared. Required headers: cal-api-version
Path parameters
Headers
Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version.
value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token
For platform customers - OAuth client secret key
For platform customers - OAuth client ID
Response
Example response
{
"status": "success",
"data": {
"id": 123,
"uid": "booking_uid_123",
"title": "Consultation",
"description": "Learn how to integrate scheduling into marketplace.",
"hosts": [
{
"id": 1,
"name": "Jane Doe",
"email": "jane100@example.com",
"displayEmail": "jane100@example.com",
"username": "jane100",
"timeZone": "America/Los_Angeles"
}
],
"status": "accepted",
"cancellationReason": "User requested cancellation",
"cancelledByEmail": "canceller@example.com",
"reschedulingReason": "User rescheduled the event",
"rescheduledByEmail": "rescheduler@example.com",
"rescheduledFromUid": "previous_uid_123",
"rescheduledToUid": "new_uid_456",
"start": "2024-08-13T15:30:00Z",
"end": "2024-08-13T16:30:00Z",
"duration": 60,
"eventTypeId": 50,
"eventType": {
"id": 1,
"slug": "some-event"
},
"meetingUrl": "https://example.com/recurring-meeting",
"location": "https://example.com/meeting",
"absentHost": true,
"createdAt": "2024-08-13T15:30:00Z",
"updatedAt": "2024-08-13T15:30:00Z",
"metadata": {
"key": "value"
},
"rating": 4,
"icsUid": "ics_uid_123",
"attendees": [
{
"name": "John Doe",
"email": "john@example.com",
"displayEmail": "john@example.com",
"timeZone": "America/New_York",
"language": "en",
"phoneNumber": "+1234567890"
}
],
"guests": [
"guest1@example.com",
"guest2@example.com"
],
"bookingFieldsResponses": {
"customField": "customValue"
}
}
}Changes
- breaking
added
subschema #3subschema #6to theresponse propertyoneOflist for the response status - info
removed
subschema #3subschema #6from theresponse propertyoneOflist for the response status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status - info
added the required property
///////to the response with the status
- breaking
- breaking
added
subschema #3subschema #6to theresponse propertyoneOflist for the response status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - breaking
removed the required property
///////from the response with the status - info
removed
subschema #3subschema #6from theresponse propertyoneOflist for the response status
- breaking