GET
/
v2
/
bookings
Get all bookings
curl --request GET \
  --url https://api.cal.com/v2/bookings \
  --header 'Authorization: <authorization>' \
  --header 'cal-api-version: <cal-api-version>'
{
  "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",
          "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",
          "timeZone": "America/New_York",
          "language": "en",
          "absent": false,
          "phoneNumber": "+1234567890"
        }
      ],
      "guests": [
        "guest1@example.com",
        "guest2@example.com"
      ],
      "bookingFieldsResponses": {
        "customField": "customValue"
      }
    }
  ],
  "pagination": {
    "totalItems": 123,
    "remainingItems": 103,
    "returnedItems": 10,
    "itemsPerPage": 10,
    "currentPage": 2,
    "totalPages": 13,
    "hasNextPage": true,
    "hasPreviousPage": true
  },
  "error": {}
}

Headers

​
cal-api-version
string
default:2024-08-13
required

Must be set to 2024-08-13

​
Authorization
string
required

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

Query Parameters

​
status
enum<string>[]

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

​
attendeeEmail
string

Filter bookings by the attendee's email address.

​
attendeeName
string

Filter bookings by the attendee's name.

​
bookingUid
string

Filter bookings by the booking Uid.

​
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.

​
afterCreatedAt
string

Filter bookings that have been created after this date string.

​
beforeCreatedAt
string

Filter bookings that have been created before this date string.

​
afterUpdatedAt
string

Filter bookings that have been updated after this date string.

​
beforeUpdatedAt
string

Filter bookings that have been updated 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
​
sortUpdatedAt
enum<string>

Sort results by their updated time (for example when booking status changes) in ascending or descending order.

Available options:
asc,
desc
​
take
number
default:100

The number of items to return

​
skip
number
default:0

The number of items to skip

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

​
pagination
object
required
​
error
object