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 Postman + Cronofy

Run in Postman

In This Section

Search