Information about the calendar event from the calendar provider.

the id provided from the calendar provider for this calendar event.

Indicates the calendar provider the event belongs to.

CalendarEvent

Provides data pertaining to the cancellation of the Event or the Invitee

The moment when the cancellation was created

The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")

The moment the event was scheduled to end in UTC time (e.g. "2020-01-02T03:04:05.678123Z")

Additional people added to an event by an invitee

An individual whom an invitee has invited to be a guest attendee to an event

Guest

Canonical reference (unique identifier) for the user

The event type associated with this event

Total invitees for an event that have not canceled

Maximum number of active invitees that can book the event

Total invitees for an event, including invitees that have canceled

The polymorphic base type for an event location that Calendly supports

Information about the physical (in-person) event location

The physical location specified by the event host (publisher)

Indicates that the event will be an in-person meeting.

In-Person Meeting

The phone number the event host (publisher) will use to call the invitee

Indicates that the event host (publisher) will call the invitee

Outbound Call

Invitee will call meeting publisher at the specified phone number

The phone number the invitee will use to call the event host (publisher)


Indicates that the invitee will call the event host

Inbound Call

Details about an Event that will take place using a Google Meet / Hangout conference. Location details will not be available 6 months after event has occurred.

Indicates the current status of the Google conference &nbsp; * Expect only `pushed` status to have a non-`null` value for the `join_url` field. &nbsp; - `processing` Location details generation pending &nbsp; - `initiated` Requesting location details from Google &nbsp; - `pushed` Location details are available &nbsp; - `failed` Error occurred or event has been canceled &nbsp; - `null` Location details are no longer available

The event location is a Google Meet or Hangouts conference

Google Conference

Meeting will take place in a Zoom conference. Location details will not be available 6 months after event has occurred.

Indicates the current status of the Zoom conference &nbsp; * Expect only `pushed` status to have non-`null` values for `join_url` & `data` fields. &nbsp; - `processing` Location details generation pending &nbsp; - `initiated` Requesting location details from Zoom &nbsp; - `pushed` Location details are available &nbsp; - `failed` Error occurred or event has been canceled &nbsp; - `null` Location details are no longer available

Zoom Conference

Details about an Event that will take place using a GotoMeeting conference. Location details will not be available 6 months after event has occurred.

The conference metadata supplied by GoToMeeting

Indicates the current status of the GoToMeeting conference &nbsp; * Expect only `pushed` status to have non-`null` values for `join_url` & `data` fields. &nbsp; - `processing` Location details generation pending &nbsp; - `initiated` Requesting location details from GoToMeeting &nbsp; - `pushed` Location details are available &nbsp; - `failed` Error occurred or event has been canceled &nbsp; - `null` Location details are no longer available

The event location is a GoToMeeting conference

GoToMeeting Conference

Meeting will take place in a Microsoft Teams conference. Location details will not be available 6 months after event has occurred.

The conference metadata supplied by Microsoft Teams

Indicates the current status of the Microsoft Teams conference &nbsp; * Expect only `pushed` status to have non-`null` values for `join_url` & `data` fields. &nbsp; - `processing` Location details generation pending &nbsp; - `initiated` Requesting location details from MS Teams &nbsp; - `pushed` Location details are available &nbsp; - `failed` Error occurred or event has been canceled &nbsp; - `null` Location details are no longer available

The event location is a Microsoft Teams conference

Microsoft Teams Conference

Use this to describe an existing Calendly-supported event location.

The location description provided by the event host (publisher)

The event location doesn't fall into a standard category defined by the event host (publisher)

Custom Location

Information about an event location that’s specified by the invitee.

The event location description provided by the invitee

The event location selected by the invitee

Invitee Specified Location

Details about an Event that will take place using a WebEx conference. Location details will not be available 6 months after event has occurred.

Indicates the current status of the WebEx conference &nbsp; * Expect only `pushed` status to have non-`null` values for `join_url` & `data` fields. &nbsp; - `processing` Location details generation pending &nbsp; - `initiated` Requesting location details from WebEx &nbsp; - `pushed` Location details are available &nbsp; - `failed` Error occurred or event has been canceled &nbsp; - `null` Location details are no longer available

WebEx Conference

Location

The moment the event was scheduled to start in UTC time (e.g. "2020-01-02T03:04:05.678123Z").

Indicates if the event is "active" or "canceled"

The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")

Canonical reference (unique identifier) for the resource

15 Minute Meeting

Events

Link to cancelling the event for the invitee

The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name.

Reference to user URI who scheduled the event

The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name.

The invitee’s name (in human-readable format)

Provides data pertaining to the associated no show for the Invitee

Canonical reference (unique identifier) for the no show

Reference to old Invitee instance that got rescheduled

The currency format that the payment is in.

Indicates whether the payment was successfully processed

A collection of the invitee's responses to questions on the event booking confirmation form

A response to a question on a booking page form

Invitee Question and Answer

Assuming reconfirmation is enabled for the event type, when reconfirmation is requested this object is present with a `created_at` that reflects when the reconfirmation notification was sent. Once the invitee has reconfirmed the `confirmed_at` attribute will change from `null` to a timestamp that reflects when they took action.

When the Invitee confirmed their attendance.

Link to rescheduling the event for the invitee

Indicates if this invitee has rescheduled. If `true`, a reference to the new Invitee instance is provided in the `new_invitee` field.

Reference to a routing form submission that redirected the invitee to a booking page.

Indicates if the invitee is "active" or "canceled"

The phone number to use when sending text (SMS) reminders

Time zone to use when displaying time to the invitee

The UTM and Salesforce tracking parameters associated with an Invitee

The UTM parameter used to track a campaign

The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code)

The UTM parameter that identifies the source (platform where the traffic originates)

Invitee Tracking

Canonical reference (unique identifier) for the invitee

Event Invitees

Indicates if this event type is managed by an organization admin

Indicates if the event type is for a poll or an instant booking

The hexadecimal color value of the event type's scheduling page

The moment the event type was created (e.g. "2020-01-02T03:04:05.678123Z")

EventTypeCustomQuestion

The moment the event type was deleted (e.g. "2020-01-02T03:04:05.678123Z"). Since event types can be deleted but their scheduled events remain it''s useful to fetch a deleted event type when you still require event type data for a scheduled event.

The event type's description (formatted with HTML)

The event type's description (in non formatted text)

The length of sessions booked with this event type

Contents of a note that may be associated with the event type

Indicates if the event type is "solo" (belongs to an individual user) or "group"

The event type name (in human-readable format)

Indicates if the event type is "round robin" (alternates between hosts) or "collective" (invitees pick a time when all participants are available) or "null" (the event type doesn’t consider the availability of a group participants)

The publicly visible profile of a User or a Team that''s associated with the Event Type (note: some Event Types don''t have profiles)

Human-readable name for the profile of the user that's associated with the event type

The unique reference to the user associated with the profile

Indicates if the profile belongs to a "user" (individual) or "team"

Profile

Tamara Jones

The URL of the user’s scheduling site where invitees book this event type

Indicates if the event type is hidden on the owner's main scheduling page

The portion of the event type's URL that identifies a specific web page (in a human-readable format)

Indicates if the event type is "AdhocEventType" (ad hoc event) or "StandardEventType" (standard event type)

The moment the event type was last updated (e.g. "2020-01-02T03:04:05.678123Z")

Canonical reference (unique identifier) for the event type

Company Name

What would you like to discuss?

Number of employees

Multi-Select Question

Phone Number

Event Types

The moment when the user''s record was created (e.g. "2020-01-02T03:04:05.678123Z")

A unique reference to the user's current organization

Resource type to support polymorphic associations.

The URL of the user's Calendly landing page (that lists all the user's event types)

The portion of URL for the user''s scheduling page (where invitees book sessions), rendered in a human-readable format

The time zone to use when presenting time to the user

The moment when the user''s record was last updated (e.g. "2020-01-02T03:04:05.678123Z")

Users

Calendly

List Event Invitees

Returns a list of  Events.

* Pass `organization` parameter to return events for that organization (requires admin/owner privilege)
* Pass `user` parameter to return events for a specific User

**NOTES:**
* If you are the admin/owner of the organization, you can use both `organization` and `user` to get a list of events for a specific user within your organization.

* `user` can only be used alone when requesting your own personal events. This will return your events within any organization that you are currently in or were a part of in the past.

List Events

Returns all Event Types associated with a specified User. Use:

* `organization` to look up all Event Types that belong to the organization

* `user` to look up a user's Event Types in an organization

Either `organization` or `user` are required query params when using this endpoint.

List User's Event Types

Returns information about a specified User.

Get user

Returns basic information about your user account.

Get current user

Returns information about a specified Invitee (person invited to an event).

Get Event Invitee

Returns information about a specified Event.

Get Event

Returns information about a specified Event Type.

Get Event Type

Returns a list of Organization Invitations that were sent to the organization's members.

List Organization Invitations

Invite User to Organization

Use this to revoke an Organization Invitation to an organization. Once revoked, the invitation link that was sent to the invitee is no longer valid.

Revoke User's Organization Invitation

Returns an Organization Invitation that was sent to the organization's members.

Get Organization Invitation

Returns information about a user's Organization Membership

Get Organization Membership

Removes a user from an organization.

Notes:

* To remove users, the caller must have admin rights for the organization

* An organization owner can’t be removed

Remove User from Organization

Use this to list the Organization Memberships for all users belonging to an organization, use:

* `user` to look up a user's membership in an organization

* `organization` to look up all users that belong to the organization

This endpoint can also be used to retrieve your organization URI.

List Organization Memberships

Create a Webhook Subscription for an Organization or User.

* The `organization` subscription scope triggers the webhook for all subscribed events within the organization.
* The `user` subscription scope only triggers the webhook for subscribed events that belong to the specific user.

| Event | Allowed Subscription Scopes |
| ----- | --------------------------- |
| <pre>invitee.created</pre> | `organization` `user` |
| <pre>invitee.canceled</pre> | `organization` `user` |
| <pre>invitee_no_show.created</pre> | `organization` `user` |
| <pre>routing_form_submission.created</pre> | `organization` Create separate Webhook Subscriptions for events with different subscription scopes. |

Create Webhook Subscription

Get a list of Webhook Subscriptions for a specified Organization or User.

List Webhook Subscriptions

Get Webhook Subscription

Delete Webhook Subscription

Create Single-Use Scheduling Link

> This endpoint requires an Enterprise subscription.

To submit a request to remove invitee data from all previously booked events in your organization, use this endpoint. Requests for data deletion can take up to 7 days to complete.

Delete Invitee Data

Returns information about a specified Invitee No Show.

Get Invitee No Show

Delete Invitee No Show

Create Invitee No Show

Cancel Event

Get a list of Routing Forms for a specified Organization.

List Routing Forms

Get Routing Form

Get a list of Routing Form Submissions for a specified Routing Form.

List Routing Form Submissions

Get Routing Form Submission

Returns a list of available times for an event type within a specified date range.

Date range can be no greater than 1 week (7 days).

**NOTE:**
* This endpoint does not support traditional keyset pagination.

List Event Type Available Times

> This endpoint requires an Enterprise subscription.

Returns a list of activity log entries

List activity log entries

Endpoint for our [Customize Once and Share](https://help.calendly.com/hc/en-us/articles/10594902199191) feature. This allows you to customize events for a specific invitee without needing to make an entirely new event type.
***This feature is only available for one-on-one event types.***
**Note: Any parameter which is not provided in the request body will be copied from the target event type.**


Create Share

Returns an ascending list of user internal and external scheduled events within a specified date range.

Date range can be no greater than 1 week (7 days).

**NOTE:**
* This endpoint does not support traditional keyset pagination.
* External events will only be returned for calendars that have "Check for conflicts" configured.

List User Busy Times

Returns the availability schedules of the given user.

List User Availability Schedules

This will return the availability schedule of the given UUID.

Get User Availability Schedule

> This endpoint requires an Enterprise subscription.

To submit a request to remove scheduled events data within a time range for your organization, use this endpoint. Requests for data deletion can take up to 7 days to complete.

Time range can be no greater than 24 months and must occur in the past.

Delete Scheduled Event Data

Microsoft Sharepoint

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Monday

Freshsales

# Continuous Import of Users to Your App

This scenario enables your application to continuously sync Users from any external application to your app's API. It handles the initial import of Users and keeps them synchronized when a User is created, updated, or deleted in the external application.

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Users to my App

Import Users and receive created/updated or deleted events

Field Name	API Key	Type	Description
Uri	uri	string	Canonical reference (unique identifier) for the resource
Name	name	string	The event name
Status	status	string	Indicates if the event is "active" or "canceled"
Start Time	start_time	string	The moment the event was scheduled to start in UTC time (e.g. "2020-01-02T03:04:05.678123Z").
End Time	end_time	string	The moment the event was scheduled to end in UTC time (e.g. "2020-01-02T03:04:05.678123Z")

Calendly API Integration Profile

How to work with Events in Calendly API

Operations on Events Collection

Build every single integration your customers need with AI