Introduction
Introduction
Authentication
The iCalendly API has 2 authentication methods:
- OAuth
- API key
1. Create an OAuth client and Continue with iCalendly
In order to be listed as an official partner and App in our App Store: iCalendly/apps you need to create and get a verified OAuth client. You can request it here: /oauth.
2. API key
While API keys can be created easily, bear in mind we almost always recommend using OAuth credentials, especially when building integrations or applications with iCalendly. You can view and manage your API keys in your settings page under the security tab in iCalendly. API Keys are under Settings > Security. Test mode secret keys have the prefix ical_ and live mode secret keys have the prefix ical_live_. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via the Authorization header. For example, the request would go something like:
'Authorization': 'Bearer YOUR_API_KEY'in your request header. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Teams endpoints
Teams customers have all the endpoints except the ones prefixed with Platform and Orgs.
Organizations endpoints
Organizations customers have all the endpoints except the ones prefixed with Platform and Teams and Orgs / Orgs because children organizations are only allowed in the platform plan right now.
Rate limits
There are two authentication methods for the API, and each of them has the following rate limits:
- API Key - 120 requests per minute. This can be increased to a reasonable amount, such as 200 requests per minute. If you require a higher rate limit, such as 800 requests per minute, it is possible, but it may involve extra charges. To request this, please contact support.
If no authentication method is provided, the default rate limit is 120 requests per minute.