Enquiry Data

Prev Next

Retrieve the enquiries your settings have received through carehome.co.uk as JSON, so you can import them into your own systems.

Who can use it: Enhanced and Platinum subscribers. By using the API you agree to our API terms of use.

List enquiries

GET /index.cfm/enquiry

Base URL https://api.carehome.co.uk. Authentication, errors and support are covered in the Enquiry API overview.

Returns every enquiry that matches your filters, oldest first. There is no pagination; all matching enquiries are returned in one response, so use dateFrom and dateTo to keep responses small. A setting's key returns that setting's enquiries; a group's key returns enquiries for the group and every active setting in it.

Query parameters

Send the parameters in the query string. Parameter names are not case-sensitive.

ParameterTypeRequiredDescription
api_keystringYesYour API key.
dateFromdate-timeNoOnly return enquiries sent on or after this date and time. See Dates.
dateTodate-timeNoOnly return enquiries sent on or before this date and time. See Dates.
categoryIdstringNoOnly return enquiries in these categories, as a comma-separated list of category IDs, for example 4,20,62. The IDs are listed in Enquiry Categories. Leave it out to return every category.
excludeAnonymisedbooleanNotrue (the default) leaves out anonymised enquiries. false includes them. See Anonymised enquiries.

Dates

We recommend the format YYYY-MM-DDTHH:MM:SS, for example 2026-01-25T09:10:00. A date without a time means midnight at the start of that day, so dateTo=2026-01-31 does not include enquiries sent during 31 January; use dateTo=2026-01-31T23:59:59 instead.

Dates and times are UK time (Europe/London, GMT or BST). If you add a UTC offset, such as Z or +01:00, the value is read as that exact moment instead.

Example request

curl "https://api.carehome.co.uk/index.cfm/enquiry?api_key=YOUR_API_KEY&dateFrom=2026-01-01T00:00:00&dateTo=2026-01-31T23:59:59&categoryId=4,20,62"

Example response

200 OK, Content-Type: application/json. The values below are illustrative.

{
  "data": [
    {
      "id": 12345678,
      "category ": {
        "id": 4,
        "name": "Care Enquiry"
      },
      "category": {
        "id": 4,
        "name": "Care Enquiry"
      },
      "member": {
        "postcode": "AB1 2CD",
        "id": 65432100000,
        "name": "Example Care Home"
      },
      "group": {
        "postcode": "AB1 2CE",
        "id": 65432100001,
        "name": "Example Care Group"
      },
      "to": "enquiries@example.com",
      "from": "example@example.com",
      "date": "2026-01-15 14:05:09",
      "content": "Example message text.",
      "firstName": "Example",
      "surname": "Name",
      "address1": "",
      "address2": "",
      "address3": "",
      "town": "",
      "postcode": "",
      "telephone": "01234 567890",
      "isAnonymised": "No",
      "categorySpecificData": {
        "fundingType": "Self funding (Private)",
        "agentOfferedATour": null,
        "whoIsNeedOfCare": "A parent",
        "stayLengthType": "Permanent/Long-term",
        "howSoonType": "1 - 3 months",
        "enquirerInterestedInATour": true,
        "careNeededType": "Older person residential",
        "personNeedingCareName": null,
        "comment": "Example message text."
      }
    }
  ],
  "error": []
}

If no enquiries match, the response is 404 with "data": [] and "error": ["No record found."]. Treat this as an empty result, not a failure.

Enquiry object

FieldTypeDescription
idintegerID of the enquiry. Phone enquiries (category 62) are numbered separately from other enquiries, so use id together with the category ID to identify an enquiry.
category objectThe same as category, under a key with a trailing space ("category "). Kept for existing integrations; use category in new ones.
categoryobjectThe enquiry's category, with id (integer) and name (string).
memberobjectThe setting the enquiry was sent to, with id (integer), name (string) and postcode (string).
groupobject or nullThe group the setting belongs to, with id, name and postcode. null if the setting is not part of a group.
tostringEmail address the enquiry was sent to. Empty string for phone enquiries.
fromstringEmail address of the person who made the enquiry. Empty string if not given.
datestringWhen the enquiry was sent, or when the call started for a phone enquiry, as YYYY-MM-DD HH:MM:SS in UK time.
contentstringThe enquiry message. For tour requests and phone enquiries this is an HTML summary of the details (for example <p><strong>Booking Details</strong>...), so it may contain HTML tags. Empty string if there is no message.
firstNamestringFirst name of the person who made the enquiry. Empty string if not given.
surnamestringSurname of the person who made the enquiry. Empty string if not given.
address1stringFirst address line. Empty string if not given; always empty for phone enquiries.
address2stringSecond address line. Empty string if not given.
address3stringThird address line. Empty string if not given.
townstringTown. Empty string if not given.
postcodestringPostcode of the person who made the enquiry. Empty string if not given.
telephonestringTelephone number of the person who made the enquiry. Empty string if not given.
isAnonymisedstring"Yes" if the enquiry has been anonymised, otherwise "No". This is a string, not a boolean.
categorySpecificDataobjectExtra details that depend on the category. See below. May be an empty object.

categorySpecificData

Which keys appear depends on the enquiry's category. A key that is present can still be an empty string or null when the person did not answer that question.

General Enquiry (1) and Job Enquiry (5)

FieldTypeDescription
commentstringThe enquirer's comment. Only present when there is one, so the object is often empty.

Brochure Request (2), Care Enquiry (4) and Care Enquiry via Care Help Team (63)

FieldTypeDescription
commentstringThe enquirer's comment. Only present when there is one.
whoIsNeedOfCarestringWho needs care, relative to the enquirer: Myself, A parent, A partner, Another family member, A friend or A client.
careNeededTypestringType of care needed, for example Older person residential, Older person residential dementia, Older person nursing, Older person nursing dementia, Other types of care or Not sure.
howSoonTypestringHow soon care is needed: Immediately (1 day - 1 week), 1 week - 1 month, 1 - 3 months, 3 - 6 months or 6 months +.
stayLengthTypestringLength of stay: Permanent/Long-term or Respite/Short-term.
fundingTypestringHow care will be paid for: Self funding (Private), Local Authority with Top-up, Local Authority, NHS Continuing Healthcare (CHC) or Not sure.
enquirerInterestedInATourboolean or nullWhether the enquirer would like a tour. null if not asked.
agentOfferedATournullAlways null for these categories; it is used by phone enquiries.
personNeedingCareNamestring or nullName of the person who needs care, if given.
personNeedingCareAgestring or nullCare Help Team enquiries (63) only. Age of the person who needs care, as text.
personNeedingCareGenderstring or nullCare Help Team enquiries (63) only. Gender of the person who needs care.

Onsite Tour/Consultation Request (20) and Remote Tour/Consultation Request (21)

FieldTypeDescription
bookingTypestringOnsite Tour/Consultation or Remote Tour/Consultation.
bookingDatestringThe requested date, written out, for example Monday 2nd February 2026.
bookingTimestringThe requested time, as HH:MM (24-hour, UK time).
bookingDateTimestringThe requested date and time in ISO 8601 format with the UK offset, for example 2026-02-02T10:30:00Z in winter or 2026-06-01T10:30:00+01:00 in summer.
commentstringThe message the enquirer added to their tour request. Empty string if they did not add one.
whoIsNeedOfCarestringWho needs care, relative to the enquirer: Myself, A parent, A partner, Another family member, A friend or A client.
careNeededTypestringType of care needed: Older person residential, Older person residential dementia, Older person nursing, Older person nursing dementia, Other types of care or Not sure.
howSoonTypestringHow soon care is needed: Immediately (1 day - 1 week), 1 week - 1 month, 1 - 3 months, 3 - 6 months or 6 months +.
stayLengthTypestringLength of stay: Permanent/Long-term or Respite/Short-term.
fundingTypestringHow care will be paid for: Self funding (Private), Local Authority with Top-up, Local Authority, NHS Continuing Healthcare (CHC) or Not sure.

Example:

"categorySpecificData": {
  "bookingType": "Onsite Tour/Consultation",
  "bookingDate": "Monday 2nd February 2026",
  "bookingTime": "10:30",
  "bookingDateTime": "2026-02-02T10:30:00Z",
  "comment": "Example message text.",
  "whoIsNeedOfCare": "A parent",
  "careNeededType": "Older person nursing",
  "howSoonType": "1 week - 1 month",
  "stayLengthType": "Respite/Short-term",
  "fundingType": "Local Authority"
}

Once a tour request has been anonymised, categorySpecificData is an empty object.

Care Enquiry via Phone (62)

FieldTypeDescription
summarystringSummary of the call.
commentstringComments recorded about the call.
enquirerTypestringWho called: Individual, Social Services, Hospital Discharge, Agency or Unknown.
agentNamestringName of the person at your setting who took the call, as recorded.
whoIsNeedOfCarestringWho needs care, relative to the caller: Myself, A parent, A partner, Another family member, A friend or A client. N/A if it was not covered on the call.
careNeededTypestringType of care needed: Older person residential, Older person residential dementia, Older person nursing, Older person nursing dementia, Other types of care or Not sure. N/A if it was not covered on the call.
howSoonTypestringHow soon care is needed: Immediately (1 day - 1 week), 1 week - 1 month, 1 - 3 months, 3 - 6 months or 6 months +. N/A if it was not covered on the call.
stayLengthTypestringLength of stay: Permanent/Long-term or Respite/Short-term. N/A if it was not covered on the call.
fundingTypestringHow care will be paid for: Self funding (Private), Local Authority with Top-up, Local Authority, NHS Continuing Healthcare (CHC) or Not sure. N/A if it was not covered on the call.
enquirerInterestedInATourbooleanWhether the caller was interested in a tour.
agentOfferedATourbooleanWhether the person who took the call offered a tour.
enquirerLeftVoicemailbooleanWhether the caller left a voicemail.
personNeedingCareFurtherRequirementsstringFurther details about the care needed.
personNeedingCareNamestring or nullName of the person who needs care, if given.
howDidAgentHandleCallstringFeedback on how the call was handled.

Anonymised enquiries

Enquiries are anonymised three years after they were sent, or straight away if the person asks us to erase their data. By default they are left out of results; add excludeAnonymised=false to include them. In an anonymised enquiry:

  • isAnonymised is "Yes".
  • to and from are anon@carehome.co.uk.
  • content, firstName, surname and telephone are anon. Address fields are anon if they had a value, otherwise an empty string.
  • In categorySpecificData, the care details are empty strings or null, comment (if present) is anon, and tour requests have an empty object.

Validation errors

A problem with the query returns 404 with "data": [] and the reasons in error:

Whenerror
dateFrom or dateTo is not a date.Please provide valid Date like '2018-12-21T09:10:00'
dateFrom or dateTo is sent with no value.A valid Date is required for 'dateFrom' (or 'dateTo')
categoryId contains an ID that is not in the category list.Invalid 'categoryId'. Values can only be in the following list [1,2,4,5,20,21,62,63]
No enquiries match.No record found.
{
  "data": [],
  "error": ["Invalid 'categoryId'. Values can only be in the following list [1,2,4,5,20,21,62,63]"]
}