Bookings

Create a booking

POST /v2/bookings is used to create regular bookings, recurring bookings and instant bookings. The request bodies for all 3 are almost the same except: If eventTypeId in the request body is id of a regular event, then regular booking is created.

If it is an id of a recurring event type, then recurring booking is created.

Meaning that the request bodies are equal but the outcome depends on what kind of event type it is with the goal of making it as seamless for developers as possible.

For team event types it is possible to create instant meeting. To do that just pass "instant": true to the request body.

The start needs to be in UTC aka if the timezone is GMT+2 in Rome and meeting should start at 11, then UTC time should have hours 09:00 aka without time zone.

Finally, there are 2 ways to book an event type:

Provide eventTypeId in the request body.
Provide eventTypeSlug and username and optionally organizationSlug if the user with the username is within an organization.

POST

bookings

curl --request POST \
  --url https://api.cal.com/v2/bookings \
  --header 'Content-Type: application/json' \
  --header 'cal-api-version: <cal-api-version>' \
  --data '{
  "start": "2024-08-13T09:00:00Z",
  "lengthInMinutes": 30,
  "eventTypeId": 123,
  "eventTypeSlug": "my-event-type",
  "username": "john-doe",
  "organizationSlug": "acme-corp",
  "attendee": {
    "name": "John Doe",
    "email": "[email protected]",
    "timeZone": "America/New_York",
    "phoneNumber": "+919876543210",
    "language": "it"
  },
  "guests": [
    "[email protected]",
    "[email protected]"
  ],
  "meetingUrl": "https://example.com/meeting",
  "location": {
    "type": "address"
  },
  "metadata": {
    "key": "value"
  },
  "bookingFieldsResponses": {
    "customField": "customValue"
  }
}'

{
  "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": "[email protected]",
        "username": "jane100",
        "timeZone": "America/Los_Angeles"
      }
    ],
    "status": "accepted",
    "cancellationReason": "User requested cancellation",
    "cancelledByEmail": "[email protected]",
    "reschedulingReason": "User rescheduled the event",
    "rescheduledByEmail": "[email protected]",
    "rescheduledFromUid": "previous_uid_123",
    "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": "[email protected]",
        "timeZone": "America/New_York",
        "phoneNumber": "+919876543210",
        "language": "it"
      }
    ],
    "guests": [
      "[email protected]",
      "[email protected]"
    ],
    "bookingFieldsResponses": {
      "customField": "customValue"
    }
  }
}

Headers

cal-api-version

string

default:2024-08-13

required

Must be set to 2024-08-13

Body

application/json

Accepts different types of booking input: Create Booking (Option 1), Create Instant Booking (Option 2), or Create Recurring Booking (Option 3)

start

string

required

The start time of the booking in ISO 8601 format in UTC timezone.

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

lengthInMinutes

number

If it is an event type that has multiple possible lengths that attendee can pick from, you can pass the desired booking length here. If not provided then event type default length will be used for the booking.

Example:

30

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[email protected]", "[email protected]"]

meetingUrl

string

deprecated

Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

metadata

object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and string values up to 500 characters.

Example:

{ "key": "value" }

bookingFieldsResponses

object

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

Example:

{ "customField": "customValue" }

start

string

required

The start time of the booking in ISO 8601 format in UTC timezone.

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

lengthInMinutes

number

Example:

30

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[email protected]", "[email protected]"]

meetingUrl

string

deprecated

Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

metadata

object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and string values up to 500 characters.

Example:

{ "key": "value" }

bookingFieldsResponses

object

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

Example:

{ "customField": "customValue" }

start

string

required

The start time of the booking in ISO 8601 format in UTC timezone.

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

instant

boolean

required

Flag indicating if the booking is an instant booking. Only available for team events.

Example:

true

lengthInMinutes

number

Example:

30

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[email protected]", "[email protected]"]

meetingUrl

string

deprecated

Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

metadata

object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and string values up to 500 characters.

Example:

{ "key": "value" }

bookingFieldsResponses

object

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

Example:

{ "customField": "customValue" }

start

string

required

The start time of the booking in ISO 8601 format in UTC timezone.

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

lengthInMinutes

number

Example:

30

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[email protected]", "[email protected]"]

meetingUrl

string

deprecated

Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

metadata

object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and string values up to 500 characters.

Example:

{ "key": "value" }

bookingFieldsResponses

object

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

Example:

{ "customField": "customValue" }

recurrenceCount

number

The number of recurrences. If not provided then event type recurrence count will be used. Can't be more than event type recurrence count

Example:

5

Response

201 - application/json

status

enum<string>

required

Available options:

success,

error

Example:

"success"

data

required

Booking data, which can be either a BookingOutput object or an array of RecurringBookingOutput objects

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

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

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

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:

"[email protected]"

data.reschedulingReason

string

Example:

"User rescheduled the event"

data.rescheduledByEmail

string

Example:

"[email protected]"

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:

["[email protected]", "[email protected]"]

Was this page helpful?

Suggest edits Raise issue

Get all bookings Get a booking

curl --request POST \
  --url https://api.cal.com/v2/bookings \
  --header 'Content-Type: application/json' \
  --header 'cal-api-version: <cal-api-version>' \
  --data '{
  "start": "2024-08-13T09:00:00Z",
  "lengthInMinutes": 30,
  "eventTypeId": 123,
  "eventTypeSlug": "my-event-type",
  "username": "john-doe",
  "organizationSlug": "acme-corp",
  "attendee": {
    "name": "John Doe",
    "email": "[email protected]",
    "timeZone": "America/New_York",
    "phoneNumber": "+919876543210",
    "language": "it"
  },
  "guests": [
    "[email protected]",
    "[email protected]"
  ],
  "meetingUrl": "https://example.com/meeting",
  "location": {
    "type": "address"
  },
  "metadata": {
    "key": "value"
  },
  "bookingFieldsResponses": {
    "customField": "customValue"
  }
}'

{
  "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": "[email protected]",
        "username": "jane100",
        "timeZone": "America/Los_Angeles"
      }
    ],
    "status": "accepted",
    "cancellationReason": "User requested cancellation",
    "cancelledByEmail": "[email protected]",
    "reschedulingReason": "User rescheduled the event",
    "rescheduledByEmail": "[email protected]",
    "rescheduledFromUid": "previous_uid_123",
    "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": "[email protected]",
        "timeZone": "America/New_York",
        "phoneNumber": "+919876543210",
        "language": "it"
      }
    ],
    "guests": [
      "[email protected]",
      "[email protected]"
    ],
    "bookingFieldsResponses": {
      "customField": "customValue"
    }
  }
}

Getting Started

Platform / Managed Users

Platform / Webhooks

Orgs / Attributes

Orgs / Attributes / Options

Orgs / Bookings

Orgs / Delegation Credentials

Orgs / Memberships

Orgs / Orgs

Orgs / Routing forms

Orgs / Schedules

Orgs / Teams

Orgs / Teams / Bookings

Orgs / Teams / Event Types

Orgs / Teams / Memberships

Orgs / Teams / Routing forms

Orgs / Teams / Routing forms / Responses

Orgs / Teams / Users / Schedules

Orgs / Users

Orgs / Users / Bookings

Orgs / Users / OOO

Orgs / Users / Schedules

Orgs / Webhooks

Api Keys

Bookings

Calendars

Conferencing

Destination Calendars

Event Types

Event Types / Webhooks

Me

OAuth Clients

Organizations/Teams Conferencing

Schedules

Selected Calendars

Slots

Stripe

Teams

Teams / Event Types

Teams / Memberships

Webhooks

Headers

Body

Response