The carehome.co.uk Enquiry API lets you bring the enquiries your settings receive through carehome.co.uk into your own systems, such as a CRM, as JSON.
Who can use it: the Enquiry API is available to Enhanced and Platinum subscribers. You need some technical knowledge to use it. By using the API you agree to our API terms of use.
Endpoints
| Method | Endpoint | Returns | Documentation |
|---|---|---|---|
| GET | /index.cfm/enquiry | Your enquiries (JSON) | Enquiry Data |
| GET | /index.cfm/enquiry/category | The enquiry categories you can filter by (JSON) | Enquiry Categories |
The Enquiry API is read-only. To have each new enquiry sent to you as it arrives, rather than collecting them on a schedule, see Enquiry Webhooks Overview.
Base URL
https://api.carehome.co.ukAll requests must use HTTPS. Both endpoints accept GET only; other methods return 405. They work with or without a trailing slash.
Authentication
Pass your API key as the api_key query parameter on every request. You can find your key in the Portal; see Viewing your API Keys.
GET https://api.carehome.co.uk/index.cfm/enquiry?api_key=YOUR_API_KEYEvery setting has its own API key, and so does every group. A setting's key returns that setting's enquiries. A group's key returns enquiries for the group and for each active setting in the group; use the member object on each enquiry to see which setting it was sent to.
Errors
If your API key is missing or not accepted, the response has an error message:
{ "error": "Invalid API key" }| Status | When | error |
|---|---|---|
| 401 | No API key was sent. | API key required |
| 401 | The API key is not recognised. | Invalid API key |
| 401 | Your subscription does not include the Enquiry API. | A message asking you to contact us to upgrade. |
| 404 | A query parameter is not valid, or no enquiries match your request. See Enquiry Data. | A list of messages, for example ["No record found."] |
| 404 | The URL is wrong. Check the path spelling. | Not Found |
| 405 | A method other than GET was used. | Method Not Allowed |
| 500 | Something went wrong on our side. Try again later; contact us if it continues. | Internal server error |
When a request is made with a valid key, the Enquiry API always returns the same envelope: data holds the results and error holds any messages. A request with a problem, or with no matching enquiries, returns 404 with an empty data list:
{
"data": [],
"error": ["No record found."]
}Anonymisation and deletion
Enquiries are anonymised after the retention period set out in the "Retaining and deleting personal data" section of our privacy policy, and straight away if someone asks us to erase their data. Anonymised enquiries are later deleted, and are then no longer returned by the API.
Anonymised enquiries are left out of results unless you ask for them; see the excludeAnonymised parameter in Enquiry Data.
Support
Email integrations@carehome.co.uk or call 01488 684321.