Destination calendars

The destination-calendars endpoint in Cal.com's API suite maps bookings for event types to particular calendars, such that the bookings show up as events on that calendar.

Please note that this endpoint does not create new credentials, but only utilizes existing credentials to create a destination calendar, where the booked events would be created.

Destination Calendar Object

AttributeDescription
id

integer

The ID of the destination calendar, generated automatically
integration

string

The integration type of the destination calendar
externalId

string

The external ID of the destination calendar
primaryEmail

string

The primary email of the destination calendar
user

User Object

The user associated with the destination calendar. Please check the Users endpoint for details on the User Object
userId

integer

The ID of the user associated with the destination calendar
booking

Bookings Object[]

List of bookings associated with this destination calendar. Please check the Bookings endpoint for details on the Booking Object
eventType

EventType Object

The event type associated with the destination calendar. Please check the EventType endpoint for details on the EventType Object
eventTypeId

integer

The ID of the event type associated with the destination calendar
credentialId

integer

The ID of the credential associated with the destination calendar
credential

Credential Object

The credential associated with the destination calendar

Example Destination Calendar Object

{
    "id": 101,
    "integration": "google_calendar",
    "externalId": "johndoe@example.com",
    "primaryEmail": "calendar@example.com",
    "user": [User Object],
    "userId": 1,
    "booking": [Booking Object[]],
    "eventType": [EventType Object],
    "eventTypeId": 301,
    "credentialId": 401,
    "credential": [Credential Object]
}

Find all destination calendars

This API call is used to get all the destination calendars of the user. A destination calendar can be global, or associated specifically with an event type. When the eventTypeId is null, the destination calendar is global.

GET

/destination-calendars

Create a new destination calendar

This API call is used to create a new destination calendar of the user.

POST

/destination-calendars

Find a destination calendar

This API call is used to get a specific destination calendar of the user identified by destination calendar id.

GET

/destination-calendars/{id}

Edit an existing destination calendar

This API call is used to get modify a specific destination calendar of the user identified by destination calendar id.

PATCH

/destination-calendars/{id}

Remove an existing destination calendar

This API call is used to remove a specific destination calendar of the user identified by destination calendar id.

DELETE

/destination-calendars/{id}

Was this page helpful?

Next

Event types