List the enquiry categories, with the IDs you can use to filter the Enquiry API.
Who can use it: Enhanced and Platinum subscribers.
List enquiry categories
GET /index.cfm/enquiry/category
Base URL https://api.carehome.co.uk. Authentication, errors and support are covered in the Enquiry API overview.
The list is the same for every API key. Use the IDs in the categoryId parameter of Enquiry Data; each enquiry's category object uses the same IDs and names.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
api_key | string | Yes | Your API key. |
Example request
curl "https://api.carehome.co.uk/index.cfm/enquiry/category?api_key=YOUR_API_KEY"
Example response
200 OK, Content-Type: application/json.
{
"data": [
{ "id": 1, "name ": "General Enquiry", "name": "General Enquiry" },
{ "id": 2, "name ": "Brochure Request", "name": "Brochure Request" },
{ "id": 4, "name ": "Care Enquiry", "name": "Care Enquiry" },
{ "id": 5, "name ": "Job Enquiry", "name": "Job Enquiry" },
{ "id": 20, "name ": "Onsite Tour/Consultation Request", "name": "Onsite Tour/Consultation Request" },
{ "id": 21, "name ": "Remote Tour/Consultation Request", "name": "Remote Tour/Consultation Request" },
{ "id": 62, "name ": "Care Enquiry via Phone", "name": "Care Enquiry via Phone" },
{ "id": 63, "name ": "Care Enquiry via Care Help Team", "name": "Care Enquiry via Care Help Team" }
],
"error": []
}
Category object
| Field | Type | Description |
|---|---|---|
id | integer | Category ID. |
name | string | The same as name, under a key with a trailing space ("name "). Kept for existing integrations; use name in new ones. |
name | string | Category name. |
Categories
| ID | Name | What it is |
|---|---|---|
| 1 | General Enquiry | A general message sent to your setting. |
| 2 | Brochure Request | A request for your brochure. |
| 4 | Care Enquiry | An enquiry about care for someone. |
| 5 | Job Enquiry | An enquiry about working at your setting. |
| 20 | Onsite Tour/Consultation Request | A request to visit your setting. |
| 21 | Remote Tour/Consultation Request | A request for a remote (video) tour. |
| 62 | Care Enquiry via Phone | A care enquiry made by phone call to your setting. |
| 63 | Care Enquiry via Care Help Team | A care enquiry passed to your setting by our Care Help team. |