General Usage Product API
Overview Authentication Versioning Pagination Error Code Status

Using Ingenuity API


The Ingenuity API is designed to enable client applications to interact with the THG Ingenuity Platform. The Ingenuity API is implemented as REST endpoints which accept JSON encoded request bodies and return JSON encoded responses.

Client applications must authenticate and be authorised to interact with the Ingenuity API. Authentication and authorisation credentials may be obtained from the THG Ingenuity Team.

The Ingenuity API is versioned. This enables us to extend our platform while maintaining compatibility with existing clients.

Release Notes

Release notes list all of the changes that are introduced by an API version. Use them to check whether your application is compatible with an API version, and what changes you might need to make before you migrate your application. API reference documentation is updated on the first business day in United Kingdom following the release date. For example, the API reference documentation for the May 3, 2023 release will be updated on May 4, 2023.