Care enquiries

An enquiry received for care, typically a care enquiry includes details of the care seeker, the service user (or users) and their care requirements.

Care enquiries have a life cycle from their initial inception through to their resolution either as a placed service user or a closed enquiry.

The care enquiry object

Attributes

  • _id
    string

    A unique Id for the care enquiry.

  • anonymized
    string

    The date/time the care enquiry was anonymized (if anonymized).

  • assigned_to
    string

    The user the care enquiry is assigned to.

  • care_requirements
    string

    A description of the service user's care requirements.

  • closing_notes
    string

    Additional notes on why the care enquiry was closed.

  • created
    string

    The date/time the care enquiry was created.

  • dementia
    boolean

    Flag indicating that the service user has dementia. If null this indicates that it is unknown if the service user has dementia.

  • dementia_challenging_behaviour
    boolean

    Flag indicating that the service user has dementia with challenging behaviour.

  • dementia_prone_to_wander
    boolean

    Flag indicating that the service user has dementia and is prone to wander.

  • dob
    string

    The service user's date of birth.

  • email
    string

    The care seeker's email address.

  • enquiring_for_self
    boolean

    Flag indicating that the care seeker is also the service user for the care enquiry.

  • first_name
    string

    The care seeker's first name.

  • funding_type
    string

    The type of funding in place for the service user; private, local_authority, local_authority_top_up, chc, chc_lifestyle, block_bed, dta_spot, not_sure.

  • genders
    list of strings

    A list of predefined service user's genders; male, female, non_binary, transgender, intersex.

  • genders_other
    string

    If one or more of the service users genders are not present in the predefined gender set then additional gender terms can be given in as other genders.

  • given_age
    integer

    The age given for the service user if the date of birth isn't known.

  • has_used_service_before
    boolean

    Flag indicating the service user has used the service before.

  • journey
    hash

    The care enquiry journey.

    • journey.pending
      hash

      Details of when the pending stage was reached.

      • journey.pending.changed
        string

        The date/time when the this milestone was completed.

      • journey.pending.user
        string

        The user who triggered the action that completed the milestone.

    • journey.spoken_to
      hash

      Details of when the spoken to stage was reached.

      • journey.spoken_to.changed
        string

        The date/time when the this milestone was completed.

      • journey.spoken_to.user
        string

        The user who triggered the action that completed the milestone.

    • journey.visit_booked
      hash

      Details of when the visit booked stage was reached.

      • journey.visit_booked.changed
        string

        The date/time when the this milestone was completed.

      • journey.visit_booked.user
        string

        The user who triggered the action that completed the milestone.

    • journey.visit_complete
      hash

      Details of when the visit complete stage was reached.

      • journey.visit_complete.changed
        string

        The date/time when the this milestone was completed.

      • journey.visit_complete.user
        string

        The user who triggered the action that completed the milestone.

    • journey.assessment_arranged
      hash

      Details of when the assessment arranged stage was reached.

      • journey.assessment_arranged.changed
        string

        The date/time when the this milestone was completed.

      • journey.assessment_arranged.user
        string

        The user who triggered the action that completed the milestone.

    • journey.assessment_complete
      hash

      Details of when the assessment complete stage was reached.

      • journey.assessment_complete.changed
        string

        The date/time when the this milestone was completed.

      • journey.assessment_complete.user
        string

        The user who triggered the action that completed the milestone.

    • journey.admitted
      hash

      Details of when the admitted stage was reached.

      • journey.admitted.changed
        string

        The date/time when the this milestone was completed.

      • journey.admitted.user
        string

        The user who triggered the action that completed the milestone.

    • journey.closed
      hash

      Details of when the closed stage was reached.

      • journey.closed.changed
        string

        The date/time when the this milestone was completed.

      • journey.closed.user
        string

        The user who triggered the action that completed the milestone.

  • last_interaction
    string

    The date/time of the last interaction with the care enquiry.

  • last_name
    string

    The care seeker's last name.

  • literature_items_downloaded
    list of strings

    A list of Ids for items of literature the care seeker has been sent and has subsequently downloaded.

  • literature_items_sent
    list of strings

    A list of Ids for items of literature the care seeker has been sent.

  • location
    string

    The Id of the location this care enquiry was received by.

  • lon_lat
    list of floats

    The geographical position of the service user's as longitude/latitude coordinates.

  • mobile
    string

    The care seeker's mobile number.

  • modified
    string

    The date/time the care enquiry was modified.

  • phone
    string

    The care seeker's phone number.

  • placed_with_competitor
    string

    The competitor the service user eventually placed with.

  • postal_address
    hash

    The care seeker's postal address.

    • postal_address.address_1
      string

      Address line 1 (e.g. house name/number).

    • postal_address.address_2
      string

      Address line 2 (e.g. street).

    • postal_address.town
      string

      Town, city or village.

    • postal_address.county
      string

      County.

    • postal_address.postcode
      string

      Postal code.

    • postal_address.country
      string

      Country.

  • reason_for_closing
    string

    The Id of the reason given for closing the care enquiry.

  • ref
    string

    A unique numeric reference for the care enquiry.

  • referrer
    string

    The Id of the referrer that referred the care enquiry.

  • referrer_other
    string

    If an exact referrer group for the care enquiry doesn't exist then the attribute can contain a description of another referrer.

  • relationship
    string

    The relationship of the care seeker to the service user, typical values include; Aunt, Brother, Brother-in-law, Cousin, Daughter, Daughter-in-law, Dentist, Discharge team member, District nurse, Doctor, Ex-husband, Ex-wife, Father, Father-in-law, Friend, Grandson, Grandson-in-law, Granddaughter, Granddaughter-in-law, Great granddaughter, Great grandson, Great nephew, Great niece, Husband, Independent broker, Lasting power of attorney, Mother, Mother-in-law, Neighbour, Nephew, Niece, Occupational therapist, Other, Partner, Sister, Sister-in-law, Social worker, Son, Son-in-law, Spiritual leader, Stepdaughter, Stepson, Uncle, Wife.

  • requires_respite
    boolean

    Flag indiciating the service user requires respite. If null this indicates that it is unknown if the service user requires respite.

  • respite_period
    string

    The period of respite required if the service user requires it.

  • sales_channel
    string

    The Id of the sales channel that the care enquiry was received via.

  • service
    string

    The service the service user requires; assisted_living, residential_home, nursing_home, learning_disability_care, bariatric_care, specialist_care, home_care, live_in_care.

  • service_user
    string

    The Id of an existing service user record this care enquiry relates to.

  • service_user_first_name
    string

    The service user's first name.

  • service_user_last_name
    string

    The service user's last name.

  • service_user_preferred_name
    string

    A name preferred by the service user.

  • service_user_title
    string

    The service user's title.

  • spoken_to_care_seeker
    boolean

    Flag indicating the care seeker has been spoken to.

  • stage
    string

    The stage the care enquiry has reached in the sales journey; pending, spoken_to, visit_booked, visit_complete, assessment_arranged, assessment_complete, admitted, closed.

  • taken_by
    string

    The Id of the user that the care enquiry was taken by.

  • timeframe_before_care_required
    string

    The timeframe before the service user requires care.

  • title
    string

    The care seeker's title.

  • town_postcode
    string

    A town or postcode associated with the service user's current location.

  • tracking_campaign
    string

    The name of the marketing campaign that generated the care enquiry.

  • tracking_id
    string

    A tracking Id for the care enquiry defined by an third-party application or source.

The care enquiry object
{
    "_id": "6724fbca4f73a2cebf63858e",
    "anonymized": null,
    "assigned_to": "6724fbc74f73a2cebf637806",
    "care_requirements": "Stuart is living at home on his own currently and is no longer able to care for herself and her family isn't located close enough to help support her.\n\nStuart is mobile but his legs feel heavy and he tends to shuffle/furniture walk. Stuart prefers not to use a frame but does have one and he will need help standing as it is an effort.\n\nStuart needs support with personal care and dressing.",
    "closing_notes": null,
    "created": "2024-10-29 12:00:00",
    "dementia": true,
    "dementia_challenging_behaviour": false,
    "dementia_prone_to_wander": false,
    "dob": "1950-12-18",
    "email": "mark.demo@crmhq.co.uk",
    "enquiring_for_self": false,
    "first_name": "Gordon",
    "funding_type": "local_authority",
    "genders": [
        "male"
    ],
    "genders_other": null,
    "given_age": 73,
    "has_used_service_before": false,
    "journey": {
        "admitted": null,
        "assessment_arranged": null,
        "assessment_complete": null,
        "closed": null,
        "pending": {
            "changed": "2024-10-29 12:00:00",
            "user": "6724fbc74f73a2cebf637806",
            "user_sticky_label": "Mark Walford <mark.demo@crmhq.co.uk>"
        },
        "spoken_to": {
            "changed": "2024-10-29 12:00:00",
            "user": "6724fbc74f73a2cebf637806",
            "user_sticky_label": "Mark Walford <mark.demo@crmhq.co.uk>"
        },
        "visit_booked": null,
        "visit_complete": null
    },
    "last_interaction": "2024-10-29 12:00:00",
    "last_name": "Parker",
    "literature_items_downloaded": [],
    "literature_items_sent": [
        "6724fbc74f73a2cebf63780c"
    ],
    "location": "6724fbc74f73a2cebf6377fa",
    "lon_lat": null,
    "mobile": "447884355387",
    "modified": "2024-11-01 16:03:22",
    "phone": "01237675680",
    "placed_with_competitor": null,
    "postal_address": {
        "address_1": "Studio 80\nGemma lane",
        "address_2": "",
        "country": "",
        "county": "Worcestershire",
        "postcode": "WR10 1HH",
        "town": "Port Shaunburgh"
    },
    "reason_for_closing": null,
    "ref": "332",
    "referrer": "6724fbc74f73a2cebf63778a",
    "referrer_other": null,
    "relationship": "Brother",
    "requires_respite": false,
    "respite_period": null,
    "sales_channel": "6724fbc74f73a2cebf6377a6",
    "service": "residential_home",
    "service_user": null,
    "service_user_first_name": "Stuart",
    "service_user_last_name": "Parker",
    "service_user_preferred_name": null,
    "service_user_title": "Ms",
    "spoken_to_care_seeker": true,
    "stage": "spoken_to",
    "taken_by": "6724fbc74f73a2cebf637806",
    "timeframe_before_care_required": "4 months",
    "title": "",
    "town_postcode": "",
    "tracking_campaign": null,
    "tracking_id": null
}

Create a care enquiry

Parameters

  • assigned_to
    optional

    The Id of the user the care enquiry is assigned to. If you do not specify a user then CareHQ will allocate a user based on the users at the associated location and their location role.

  • care_requirements
    optional

    A description of the care requirements for the service user.

  • created
    optional

    The date/time the care enquiry was received. Defaults to the date/time the document was created on CareHQ.

  • dementia
    optional

    A boolean indicating if the service user has dementia, if not specified this indicates that it is unknown if the service user has dementia.

    • yes
    • no
  • dementia_challenging_behaviour
    optional

    A boolean indicating if the service user has challenging behaviour. This field cannot be set if the service user does not have dementia.

  • dementia_prone_to_wander
    optional

    A boolean indicating if the service user is prone to wander. This field cannot be set if the service user does not have dementia.

  • dob
    optional

    The service user's date of birth, a date of birth or an estimated age is required.

  • email
    optional

    The care seeker's email address. Please note an phone/mobile number or email address is required.

  • enquiring_for_self
    optional

    A boolean indicating if the care seeker is enquiring for themself.

  • first_name
    optional

    The care seeker's first name.

  • funding_type
    required

    The type of funding in place to fund the service user's care.

    • private
    • local_authority
    • local_authority_top_up
    • chc
    • chc_lifestyle
    • block_bed
    • dta_spot
    • not_sure
  • genders
    optional

    The service user's gender.

    • male
    • female
    • non_binary
    • transgender
    • intersex
  • genders_other
    optional

    Any other genders for the service user not defined in the predefined list of genders.

  • given_age
    optional

    The service user's estimated age, a date of birth or an estimated age is required.

  • has_used_service_before
    optional

    A boolean indicating if the service user has used your service before.

  • last_name
    required

    The care seeker's last name.

  • literature_items_downloaded
    optional

    A list of Ids for literature items that have been downloaded by the care seeker.

  • literature_items_sent
    optional

    A list of Ids for literature items that have been sent to the care seeker.

  • location
    required

    The Id of the location the care enquiry relates to.

  • mobile
    optional

    The care seeker's mobile number.

  • phone
    optional

    The care seeker's phone number.

  • postal_address-address_1
    optional

    Address line 1 (e.g. house name/number).

  • postal_address-address_2
    optional

    Address line 2 (e.g. street).

  • postal_address-country
    optional

    Country.

  • postal_address-county
    optional

    County.

  • postal_address-postcode
    optional

    Postal code.

  • postal_address-town
    optional

    Town, city or village.

  • referrer
    optional

    The Id of the referrer (group) that referred the care enquiry.

  • referrer_other
    optional

    If an exact referrer group for the care enquiry doesn't exist then a description of another referrer can be provided.

  • relationship
    optional

    The care seeker's relationship to the service user, common values include: Aunt, Brother, Brother-in-law, Cousin, Daughter, Daughter-in-law, Dentist, Discharge team member, District nurse, Doctor, Ex-husband, Ex-wife, Father, Father-in-law, Friend, Grandson, Grandson-in-law, Granddaughter, Granddaughter-in-law, Great granddaughter, Great grandson, Great nephew, Great niece, Husband, Independent broker, Lasting power of attorney, Mother, Mother-in-law, Neighbour, Nephew, Niece, Occupational therapist, Other, Partner, Sister, Sister-in-law, Social worker, Son, Son-in-law, Spiritual leader, Stepdaughter, Stepson, Uncle, Wife.

  • requires_respite
    optional

    A boolean indicating if the care seeker requires respite care for the service user. If not specified this indicates that it is unknown if the service user requires respite.

    • yes
    • no
  • respite_period
    optional

    The estimated period of respite required for the service user. This field is required if the service user requires respite.

  • sales_channel
    required

    The Id of the sales channel (group) the care enquiry arrived via.

  • service
    required

    The care service required by the service user.

    • assisted_living
    • residential_home
    • nursing_home
    • learning_disability_care
    • bariatric_care
    • specialist_care
    • home_care
    • live_in_care
  • service_user
    optional

    The Id of an existing service user record for the service user associated with this care enquiry.

  • service_user_first_name
    optional

    The service user's first name.

  • service_user_last_name
    optional

    The service user's last name.

  • service_user_preferred_name
    optional

    A name preferred by the service user.

  • service_user_title
    optional

    The service user's title, common values include include: Mr, Mrs, Miss, Dr, Rev.

  • spoken_to_care_seeker
    optional

    A boolean indicating if the care seeker has been spoken to.

  • timeframe_before_care_required
    optional

    The estimated timeframe before the service user will require care.

  • title
    optional

    The care seeker's title, common values include include: Mr, Mrs, Miss, Dr, Rev.

  • town_postcode
    optional

    The town or postcode where the service user is currently located.

  • tracking_campaign
    optional

    The name of the marketing campaign that generated the care enquiry.

  • tracking_id
    optional

    A tracking Id for the care enquiry defined by an third-party application or source.

  • untrusted_source
    optional

    A boolean indicating that the source of the enquiry is untrusted and may include invalid or junk enquiries. By flagging a care enquiry as from an untrusted source it makes it possible for users to delete invalid / junk enquiries when closing them.

Response

Returns the care enquiry object created.

PUT
/v1/care-enquiries
var careEnquiry = apiClient.Request(
    HttpMethod.Put,
    "care-enquiries",
    null,
    new MultiValueDict()
        .Add(
            "care_requirements",
            "Fred is living at home on his own with " +
            "the support of family. The family are looking for care " +
            "to support Fred longer term."
        )
        .Add("dementia", "yes")
        .Add("dementia_challenging_behaviour", "yes")
        .Add("dementia_prone_to_wander", "yes")
        .Add("dob", "1932-05-03")
        .Add("email", "bob.foster@gmail.com")
        .Add("first_name", "Bob")
        .Add("funding_type", "private")
        .Add("last_name", "Foster")
        .Add("location", locationId)
        .Add("mobile", "07511 651299")
        .Add("phone", "01620 250017")
        .Add("referrer", referrerId)
        .Add("relationship", "Son")
        .Add("sales_channel", salesChannelId)
        .Add("service", "residential_home")
        .Add("service_user_first_name", "Fred")
        .Add("service_user_last_name", "Foster")
        .Add("service_user_title", "Mr")
        .Add("spoken_to_care_seeker", "yes")
        .Add("timeframe_before_care_required", "2 weeks")
        .Add("title", "Mr")
        .Add("town_postcode", "HP27 9ST")
);
<?php

$care_enquiry = $api_client->request(
    'PUT',
    'care-enquiries',
    NULL,
    [
        'care_requirements'=>'Fred is living at home on his own with '
            . 'the support of family. The family are looking for care '
            . 'to support Fred longer term.',
        'dementia'=>'yes',
        'dementia_challenging_behaviour'=>'yes',
        'dementia_prone_to_wander'=>'yes',
        'dob'=>'1932-05-03',
        'email'=>'bob.foster@gmail.com',
        'first_name'=>'Bob',
        'funding_type'=>'private',
        'last_name'=>'Foster',
        'location'=>$location_id,
        'mobile'=>'07511 651299',
        'phone'=>'01620 250017',
        'referrer'=>$referrer_id,
        'relationship'=>'Son',
        'sales_channel'=>$sales_channel_id,
        'service'=>'residential_home',
        'service_user_first_name'=>'Fred',
        'service_user_last_name'=>'Foster',
        'service_user_title'=>'Mr',
        'spoken_to_care_seeker'=>'yes',
        'timeframe_before_care_required'=>'2 weeks',
        'title'=>'Mr',
        'town_postcode'=>'HP27 9ST'
    ]
);
care_enquiry = api_client(
    'PUT',
    'care-enquiries',
    data={
        'care_requirements': (
            'Fred is living at home on his own with the support of '
            'family. The family are looking for care to support Fred '
            'longer term.'
        ),
        'dementia': 'yes',
        'dementia_challenging_behaviour': 'yes',
        'dementia_prone_to_wander': 'yes',
        'dob': '1932-05-03',
        'email': 'bob.foster@gmail.com',
        'first_name': 'Bob',
        'funding_type': 'private',
        'last_name': 'Foster',
        'location': location_id,
        'mobile': '07511 651299',
        'phone': '01620 250017',
        'referrer': referrer_id,
        'relationship': 'Son',
        'requires_respite': 'no',
        'sales_channel': sales_channel_id,
        'service': 'residential_home',
        'service_user_first_name': 'Fred',
        'service_user_last_name': 'Foster',
        'service_user_title': 'Mr',
        'spoken_to_care_seeker': 'yes',
        'timeframe_before_care_required': '2 weeks',
        'title': 'Mr',
        'town_postcode': 'HP27 9ST'
    }
)
care_enquiry = api_client.request(
    'PUT',
    'care-enquiries',
    data: {
        'care_requirements' => 'Fred is living at home on his own with ' +
            'the support of family. The family are looking for care ' +
            'to support Fred longer term.',
        'dementia' => 'yes',
        'dementia_challenging_behaviour' => 'yes',
        'dementia_prone_to_wander' => 'yes',
        'dob' => '1932-05-03',
        'email' => 'bob.foster@gmail.com',
        'first_name' => 'Bob',
        'funding_type' => 'private',
        'last_name' => 'Foster',
        'location' => location_id,
        'mobile' => '07511 651299',
        'phone' => '01620 250017',
        'referrer' => referrer_id,
        'relationship' => 'Son',
        'sales_channel' => sales_channel_id,
        'service' => 'residential_home',
        'service_user_first_name' => 'Fred',
        'service_user_last_name' => 'Foster',
        'service_user_title' => 'Mr',
        'spoken_to_care_seeker' => 'yes',
        'timeframe_before_care_required' => '2 weeks',
        'title' => 'Mr',
        'town_postcode' => 'HP27 9ST'
    }
)
Response
{
    "_id": "6724fbd43cd2cde34170f2b8",
    "assigned_to": "6724fbc74f73a2cebf637800",
    "care_requirements": "Fred is living at home on his own with the support of family. The family are looking for care to support Fred longer term.",
    "created": "2024-11-01 16:03:32",
    "dementia": true,
    "dementia_challenging_behaviour": true,
    "dementia_prone_to_wander": true,
    "dob_str": "1932-05-03",
    "email": "bob.foster@gmail.com",
    "enquiring_for_self": false,
    "first_name": "Bob",
    "funding_type": "private",
    "genders": [],
    "genders_other": "",
    "given_age": null,
    "has_used_service_before": false,
    "journey": {
        "admitted": null,
        "assessment_arranged": null,
        "assessment_complete": null,
        "closed": null,
        "pending": {
            "changed": "2024-11-01 16:03:32",
            "user": "CareHQ API: Demo (6724fbc74f73a2cebf6376fc)",
            "user_sticky_label": "CareHQ API: Demo (6724fbc74f73a2cebf6376fc)"
        },
        "spoken_to": {
            "changed": "2024-11-01 16:03:32",
            "user": "CareHQ API: Demo (6724fbc74f73a2cebf6376fc)",
            "user_sticky_label": "CareHQ API: Demo (6724fbc74f73a2cebf6376fc)"
        },
        "visit_booked": null,
        "visit_complete": null
    },
    "last_interaction": "2024-11-01 16:03:32",
    "last_name": "Foster",
    "literature_items_downloaded": [],
    "literature_items_sent": [],
    "location": "6724fbc74f73a2cebf6377fa",
    "lon_lat": [
        -0.8619,
        51.7412
    ],
    "mobile": "07511 651299",
    "modified": "2024-11-01 16:03:32",
    "phone": "01620 250017",
    "postal_address": {
        "address_1": "",
        "address_2": "",
        "country": "",
        "county": "",
        "postcode": "",
        "town": ""
    },
    "ref": "592",
    "referrer": "6724fbc74f73a2cebf637780",
    "referrer_other": "",
    "relationship": "Son",
    "requires_respite": false,
    "respite_period": null,
    "sales_channel": "6724fbc74f73a2cebf6377a6",
    "service": "residential_home",
    "service_user": null,
    "service_user_first_name": "Fred",
    "service_user_last_name": "Foster",
    "service_user_preferred_name": "",
    "service_user_title": "Mr",
    "spoken_to_care_seeker": true,
    "stage": "spoken_to",
    "timeframe_before_care_required": "2 weeks",
    "title": "Mr",
    "town_postcode": "HP27 9ST"
}

List all care enquiries

Return a list of enquiries from care seekers.

Parameters

  • attributes
    optional
    default ['_id']

    A list of attributes to include for fetched objects.

  • filters-anonymized
    optional
    default unset

    A filter that allows care enquiries to be filtered by whether the enquiry is anonymized.

    • unset
    • yes
    • no
  • filters-assigned_to
    optional

    A filter that accepts a list of user Ids and filters care enquiries by the user they are assigned.

  • filters-end_date
    optional

    A filter that accepts a date and filters care enquiries to those created on or before the given date.

  • filters-ids
    optional

    A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.

  • filters-location
    optional

    A filter that accepts a list of location Ids and filters care enquiries by the location they were received for.

  • filters-modified_after
    optional

    A filter that accepts a date/time and filters the items returned to those modified after the date/time.

  • filters-modified_before
    optional

    A filter that accepts a date/time and filters the items returned to those modified before the date/time.

  • filters-q
    optional

    A case insensitive keyword filter applied to the following fields; ref, full_name, service_user_full_name.

  • filters-requires_respite
    optional
    default unset

    A filter that allows care enquiries to be filtered by whether the service user requires respite care or not.

    • unset
    • yes
    • no
  • filters-stage
    optional

    A filter that accepts a list of stages a care enquiry can be at and filters care enquiries by their current stage.

    • pending
    • spoken_to
    • visit_booked
    • visit_complete
    • assessment_arranged
    • assessment_complete
    • admitted
    • closed
  • filters-start_date
    optional

    A filter that accepts a date and filters care enquiries to those created on or after the given date.

  • filters-tracking_campaign
    optional

    A filter that allows care enquiries to be filtered by the tracking (marketing) campaign that generated it.

  • filters-tracking_id
    optional

    A filter that allows care enquiries to be filtered by the tracking Id they are assigned.

  • page
    optional
    default 1

    The page number to fetch.

  • per_page
    optional
    default 10

    The number of items to return per page.

  • sort_by
    optional
    default _id

    A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.

    • _id
    • created
    • modified
    • full_name
    • service_user_full_name

Response

Returns a page of care enquiries.

GET
/v1/care-enquiries
var careEnquiries = apiClient.Request(
    HttpMethod.Get,
    "care-enquiries",
    new MultiValueDict()
        .Add("attributes", "ref", "first_name", "last_name")
        .Add("filters-stage", "visit_booked")
        .Add("sort_by", "full_name")
);
<?php

$care_enquiries = $api_client->request(
    'GET',
    'care-enquiries',
    [
        'attributes'=>['ref', 'first_name', 'last_name'],
        'filters-stage'=>['visit_booked'],
        'sort_by'=>'full_name'
    ]
);
care_enquiries = api_client(
    'GET',
    'care-enquiries',
    params={
        'attributes': ['ref', 'first_name', 'last_name'],
        'filters-stage': ['visit_booked'],
        'sort_by': 'full_name'
    }
)
care_enquiries = api_client.request(
    'GET',
    'care-enquiries',
    params: {
        'attributes' => ['ref', 'first_name', 'last_name'],
        'filters-stage' => ['visit_booked'],
        'sort_by' => 'full_name'
    }
)
Response
{
    "item_count": 1,
    "items": [
        {
            "_id": "6724fbca4f73a2cebf638580",
            "first_name": "Sara",
            "last_name": "Sullivan",
            "ref": "329"
        }
    ],
    "page": 1,
    "page_count": 1,
    "per_page": 10
}

Retrieve a care enquiry

Retreive a care enquiry object.

Response

Returns a care enquiry object.

GET
/v1/care-enquiries/<care_enquiry_id>
var careEnquiry = apiClient.Request(
    "GET",
    $"care-enquiries/{careEnquiryId}"
);
<?php

$care_enquiry = $api_client->request(
    'GET',
    'care-enquiries/' . $care_enquiry_id
);
care_enquiry = api_client('GET', f'care-enquiries/{care_enquiry_id}')
care_enquiry = api_client.request('GET', "care-enquiries/#{care_enquiry_id}")
Response
{
    "_id": "6724fbca4f73a2cebf63858e",
    "anonymized": null,
    "assigned_to": "6724fbc74f73a2cebf637806",
    "care_requirements": "Stuart is living at home on his own currently and is no longer able to care for herself and her family isn't located close enough to help support her.\n\nStuart is mobile but his legs feel heavy and he tends to shuffle/furniture walk. Stuart prefers not to use a frame but does have one and he will need help standing as it is an effort.\n\nStuart needs support with personal care and dressing.",
    "closing_notes": null,
    "created": "2024-10-29 12:00:00",
    "dementia": true,
    "dementia_challenging_behaviour": false,
    "dementia_prone_to_wander": false,
    "dob": "1950-12-18",
    "email": "mark.demo@crmhq.co.uk",
    "enquiring_for_self": false,
    "first_name": "Gordon",
    "funding_type": "local_authority",
    "genders": [
        "male"
    ],
    "genders_other": null,
    "given_age": 73,
    "has_used_service_before": false,
    "journey": {
        "admitted": null,
        "assessment_arranged": null,
        "assessment_complete": null,
        "closed": null,
        "pending": {
            "changed": "2024-10-29 12:00:00",
            "user": "6724fbc74f73a2cebf637806",
            "user_sticky_label": "Mark Walford <mark.demo@crmhq.co.uk>"
        },
        "spoken_to": {
            "changed": "2024-10-29 12:00:00",
            "user": "6724fbc74f73a2cebf637806",
            "user_sticky_label": "Mark Walford <mark.demo@crmhq.co.uk>"
        },
        "visit_booked": null,
        "visit_complete": null
    },
    "last_interaction": "2024-10-29 12:00:00",
    "last_name": "Parker",
    "literature_items_downloaded": [],
    "literature_items_sent": [
        "6724fbc74f73a2cebf63780c"
    ],
    "location": "6724fbc74f73a2cebf6377fa",
    "lon_lat": null,
    "mobile": "447884355387",
    "modified": "2024-11-01 16:03:22",
    "phone": "01237675680",
    "placed_with_competitor": null,
    "postal_address": {
        "address_1": "Studio 80\nGemma lane",
        "address_2": "",
        "country": "",
        "county": "Worcestershire",
        "postcode": "WR10 1HH",
        "town": "Port Shaunburgh"
    },
    "reason_for_closing": null,
    "ref": "332",
    "referrer": "6724fbc74f73a2cebf63778a",
    "referrer_other": null,
    "relationship": "Brother",
    "requires_respite": false,
    "respite_period": null,
    "sales_channel": "6724fbc74f73a2cebf6377a6",
    "service": "residential_home",
    "service_user": null,
    "service_user_first_name": "Stuart",
    "service_user_last_name": "Parker",
    "service_user_preferred_name": null,
    "service_user_title": "Ms",
    "spoken_to_care_seeker": true,
    "stage": "spoken_to",
    "taken_by": "6724fbc74f73a2cebf637806",
    "timeframe_before_care_required": "4 months",
    "title": "",
    "town_postcode": "",
    "tracking_campaign": null,
    "tracking_id": null
}

Close a care enquiry

Close a care enquiry that has failed to convert.

Parameters

  • closing_notes
    required

    Notes on why the care enquiry closed. A comment will also be created and appended to the care enquiry from the closing notes.

  • placed_with_competitor
    optional

    The Id of the competitor (group) the care enquiry placed with.

  • reason_for_closing
    required

    The Id of the reason (group) the care enquiry closed.

Response

Returns the care enquiry object that was closed.

PATCH
/v1/care-enquiries/<care_enquiry_id>/close
var careEnquiry = apiClient.Request(
    HttpMethod.Patch,
    $"care-enquiries/{care_enquiry_id}/close",
    null,
    new MultiValueDict()
        .Add("reason_for_closing", reasonForClosingId)
        .Add(
            "closing_notes",
            "Based on the follow up call we" +
            "determined we are unable to meet Gordon's care need."
        )
);
<?php

$care_enquiry = $api_client->request(
    'PATCH',
    'care-enquiries/' . $care_enquiry_id . '/close',
    NULL,
    [
        'reason_for_closing'=>$reason_for_closing_id,
        'closing_notes'=>'Based on the follow up call we '
            . 'determined we are unable to meet Gordon's care need.'
    ]
);
care_enquiry = api_client(
    'PATCH',
    f'care-enquiries/{care_enquiry_id}/close',
    data={
        'reason_for_closing': reason_for_closing_id,
        'closing_notes': (
            "Based on the follow up call we determined we are unable "
            "to meet Gordon's care need."
        )
    }
)
care_enquiry = api_client.request(
    'PATCH',
    "care-enquiries/#{care_enquiry_id}/close",
    data: {
        'reason_for_closing' => reason_for_closing_id,
        'closing_notes' => 'Based on the follow up call we ' +
            'determined we are unable to meet Gordon's care need.'
    }
)
Response
{
    "_id": "6724fbd34f73a2cebf638f19",
    "assigned_to": "6724fbc74f73a2cebf637800",
    "care_requirements": "Fred is living at home on his own with the support of family. The family are looking for care to support Fred longer term.",
    "closing_notes": "Based on the follow up call we determined we are unable to meet Gordon's care need.",
    "created": "2024-11-01 16:03:31",
    "dementia": true,
    "dementia_challenging_behaviour": true,
    "dementia_prone_to_wander": true,
    "dob_str": "1932-05-03",
    "email": "bob.foster@gmail.com",
    "enquiring_for_self": false,
    "first_name": "Bob",
    "funding_type": "private",
    "genders": [],
    "journey": {
        "admitted": null,
        "assessment_arranged": null,
        "assessment_complete": null,
        "closed": {
            "changed": "2024-11-01 16:03:32",
            "user": "CareHQ API: Demo (6724fbc74f73a2cebf6376fc)",
            "user_sticky_label": "CareHQ API: Demo (6724fbc74f73a2cebf6376fc)"
        },
        "pending": {
            "changed": "2024-11-01 16:03:31",
            "user": null,
            "user_sticky_label": "api-fixture"
        },
        "spoken_to": {
            "changed": "2024-11-01 16:03:31",
            "user": null,
            "user_sticky_label": "api-fixture"
        },
        "visit_booked": null,
        "visit_complete": null
    },
    "last_interaction": "2024-11-01 16:03:32",
    "last_name": "Foster",
    "literature_items_downloaded": [],
    "literature_items_sent": [],
    "location": "6724fbc74f73a2cebf6377fa",
    "lon_lat": [
        -0.861925,
        51.741801
    ],
    "mobile": "07511 651299",
    "modified": "2024-11-01 16:03:32",
    "phone": "01620 250017",
    "placed_with_competitor": null,
    "postal_address": {
        "address_1": "",
        "address_2": "",
        "country": "",
        "county": "",
        "postcode": "",
        "town": ""
    },
    "reason_for_closing": "6724fbc74f73a2cebf63774e",
    "ref": "591",
    "referrer": "6724fbc74f73a2cebf637780",
    "relationship": "Son",
    "sales_channel": "6724fbc74f73a2cebf6377a6",
    "service": "residential_home",
    "service_user_first_name": "Fred",
    "service_user_last_name": "Foster",
    "service_user_title": "Mr",
    "spoken_to_care_seeker": true,
    "stage": "closed",
    "timeframe_before_care_required": "2 weeks",
    "title": "Mr",
    "town_postcode": "HP27 9ST"
}