Enquiry API overview

API Contacts

01488 684321

integrations@carehome.co.uk

API Terms of Use
Click here to view our API terms of use.

Terms
Member = A Care Home with an account on carehome.co.uk 

Overview

The API’s we provide give read only access to enquiries via JSON REST Based interface.

Authentication

To make a request to our API you must pass the API_key of the client in question, these keys may be passed either in the URL (for GET requests) or in the JSON body of the request in other methods (PUT/POST).

API Keys are automatically assigned to all Members on creation and are available on request or in your Control Panel.

Access Restrictions

A Platinum service subscription is required to access this API.

GDPR Anonymisation & Deletion Policies

In accordance with our GDPR data retention policies enquiry data is anonymised after a three year period and deleted after six years.

In accordance with the right to erasure any enquiries sent via a user that has asked to be "erased" will be immediately deleted.Click here