API Documentation

Please note that our legacy API documentation is no longer on this site. You can find our legacy API documentation here - https://legacyapi.crunch.co.uk/ Please contact us at api@crunch.co.uk if you have an application that uses our legacy api, so we can discuss moving you over to our new api

The Crunch application programming interface (API) has been introduced to allow developers the ability to integrate data and services from Crunch into third-party applications.

Our API has been developed in accordance with industry standard technologies and approaches so as to make its adoption and use as simple as possible. In order to utilise our API, developers will need at least a basic understanding of the following:

  • REST
  • JSON
  • OAuth 2.0


All of our API endpoints are secured via OAuth 2.0, which means that no 3rd party can access our client’s data without permission, and that our clients are never required to enter their Crunch username & password into a 3rd party system. For more information on OAuth and Crunch please see the Authentication and OAuth page.


The documentation available through our developer portal should give you everything you need in order to utilise the Crunch API.

  • The static documentation highlights the available endpoints and the structure of the JSON payloads, to give developers an idea of what data they can extract and create.

Of course, if there is anything you need to know about the Crunch API then do not hesitate to contact api@crunch.co.uk.