API Reference
This API reference contains all of our stable API features. These are fully operational and no breaking changes to the API will be made.
We lean on existing standards where possible in order to simplify integration for clients.
We do make additive changes to our API so your application should adopt a permissive approach to parsing responses, ignoring any attributes your client doesn’t understand.
We work very hard to ensure behaviour is maintained. New features that allow for different behaviour are always explict opt-in. Either through use of optional parameters or possible future versions of the API.
BETA features are generally recently released or enhanced and are being closely monitored for performance under real-world conditions. They are stable from an interface perspective.
We are always extending the capabilities of our API. Our ALPHA API contains the latest features for you to try out. These are available to use in production. We’re keen to speak to anyone using these features so please contact us support@cronofy.com if you have any questions or feedback.
All API requests can be made with a JSON- or forms-encoded request body, though a JSON-encoded request is recommended. You should specify the Content-Type header of your requests as either application/json; charset=utf-8 or application/x-www-form-urlencoded to signal your request body is JSON- or forms-encoded, respectively.
You can explore the API using Postman. More information on Using Postman
In This Section
- Data Types The API can receive requests and return responses comprising of specific data types.
- Errors For API responses, we use conventional HTTP response codes to indicate the success or failure of an API request.
- Authentication There are two forms of authentication within the Cronofy API. Broadly speaking this is split into two categories 1) Authenticating as a specific user 2) Authenticating as an application
- Individual Connect Authorization to access a user's calendars is done via the OAuth 2.0 protocol, Specifically the "Authorization Code" version of authorization as specified in 4.1 of RFC 6749
- Enterprise Connect Enterprise Connect allows you to gain access to the calendars of an entire organization. This eliminates the need to have each calendar user in an organization individually grant access to their calendar.
- Organization Connect Authorization to access a user's Cronofy Organization Account calendars is done via the OAuth 2.0 protocol, Specifically the "Authorization Code" version of authorization as specified in 4.1 of RFC 6749
- Availability The Availability API endpoints provide tools for finding times for one or more people and/or resources.
- Calendars Interacting with the calendars in a user's calendar accounts.
- Events Interacting with the events in a user's calendars.
- Smart Invites Smart Invites allow you to send your users calendar invites and be informed of their interactions with them (accept, decline, etc) without needing any calendar authorization.
- Event Triggers Subscribe to receive notifications based on event transitions
- Push Notifications Push notifications provide a mechanism to lazily retrieve information about an account in order to avoid the need for API clients to create polling infrastructure.
- Conferencing Services Conferencing services can be used to generate video and phone for events created through the Cronofy API
- Identity Endpoints concerned with information about user accounts and calendar service connections (Profiles).
- Batch The batch endpoint effectively allows up to 50 requests to be sent at once.
- Scheduling Requests The Scheduling Requests endpoints allow the creation, querying and cancellation of Scheduling Requests created from either our APIs or via the Scheduler. This can be either from the calling application or by using the end user's Scheduler account.