Calendly API overview

Calendly's API connects your software systems with our scheduling platform. You can automate tasks, sync data, and improve scheduling.

This guide covers the basics to help you get started. Check out the Developer Portal and the Developer Community for advanced help.

How the Calendly API works

API Request

All Calendly users can send a request to get information or complete a task using our API. You’ll include what kind of data or action you need in the request.

Each request is secured with a personal access token (PAT), which lets the API know what you’re allowed to do. Our reference pages in the portal explain how to format your request and include all the details you need.

API Processing

When a request is sent, our servers collect data, process calculations, or complete tasks based on your input. The server then sends a response that matches your request.

Request example:

Response

Once your request is processed, a response is sent to you. It will either include the data you asked for or confirm that the action was completed. All responses follow standard API formats.

Response example:

Error Handling

If an error happens, it’s handled with preset messages and codes. These help with troubleshooting or when you need support from the Calendly team.

Error example:

Webhooks

Webhooks provide real-time updates to your systems when events occur in Calendly. Once set up, Calendly will notify you instantly if a meeting is scheduled, rescheduled, or canceled. This lets you automate tasks or trigger actions based on these updates. For more details, review our article on webhooks.

API access by subscription plan

Developers can make GET and POST requests to API endpoints on behalf of a Calendly user on any subscription plan, including the Basic plan.

However, certain endpoints are available only to the Enterprise plan:

• List activity entry logs
• Delete invitee data
• Delete scheduled event data

For webhooks, the Calendly user must have a paid subscription on the Professional, Standard, Teams, or Enterprise plan. Explore each plan’s features on our pricing page.

User vs admin/owner scopes

When generating tokens to authenticate Calendly’s API, the level of access depends on the user’s role. The scope of available data depends on whether the token is generated by a user or an admin/owner:

• User role: A token generated by a user only allows access to data linked to that specific user. This includes webhooks that trigger for events like scheduled or canceled meetings related to the individual user.
• Admin/Owner role: Tokens generated by an admin or owner provide broader access. These tokens allow API calls to manage data across the entire organization or within groups.

How to create a personal access token

Verify that you are generating the token from the correct account (user or admin/owner) to set the appropriate scope of access.

1. Visit your Integrations page and select API and webhooks.
2. To create a new personal access token, select Get a token now.
3. Under Choose a name for this token, add a name.
4. Select Create token.
5. You’ll be prompted to enter an authentication code. Check your email for the code, then enter it to complete the verification.
6. Once the personal access token is generated, select Copy token.

After you generate your personal access token, check out our guide on API capabilities and creating integrations in our Getting Started Guide on the Developer Portal.

Security and compliance

The security of your integration is our top priority. Our API adheres to the best practices for security and data compliance, ensuring that your information stays safe. For more details, see our Calendly Platform Security and Compliance article.

Through the API, you can make manage organization users by:

• Inviting users to join your organization
• Revoking invitations
• Removing users from your organization

You can also integrate your app using OAuth 2.0 for secure authorization.