Skip to Content
Client Assist APIGETRetrieve an enquiry

Retrieve an enquiry

GET/api/v2/client-assist/{id}

Returns one Client Assist enquiry: the client’s description of their problem, their contact details, their answers to the questions they were asked, and where the enquiry stands with your firm.

Path parameters

ParamTypeRequiredDescription
idstringRequiredThe enquiry’s id, as returned by List enquiries. For example RS-4f1c2a9be07d3e18.

Request

GET /api/v2/client-assist/{id}
curl --location 'https://www.reviewsolicitors.co.uk/api/v2/client-assist/{id}' \ --header 'Authorization: Bearer {access_token}'

Response

200 OK
{ "id": "RS-4f1c2a9be07d3e18", "status": "SUBMITTED", "clientAssistPlus": false, "createdDate": "2026-08-01T10:22:46", "clientName": "Jane Doe", "clientEmail": "jane.doe@example.com", "clientPhone": "+447700900123", "contactRevealed": false, "contactRevealedAt": null, "message": "I want to start divorce proceedings as soon as possible.", "timeframe": "PERIOD_1_2", "workAreaId": 295, "workArea": "Divorce", "mainWorkAreaId": 665, "mainWorkArea": "Family Law", "officeId": 65196, "officeName": "Leeds", "professionalId": null, "professionalName": null, "rejectedAt": null, "rejectReason": null, "rejectDetails": null, "reportedAt": null, "reportReason": null, "reportDetails": null, "questions": [ { "question": "Are there children under 18 who are subject to parental responsibility?", "answer": "No" }, { "question": "Is there any ongoing court order involving either party?", "answer": "No" } ] }

The example above contains placeholder data. Real enquiries carry your own clients’ details.

The enquiry object

FieldTypeDescription
idstringThe enquiry’s unique reference. Use it in every other Client Assist endpoint.
statusstringWhere the enquiry stands with your firm. See Enquiry statuses.
clientAssistPlusbooleanWhether the enquiry came through your own Client Assist+ widget or link, rather than the ReviewSolicitors site.
createdDatestringWhen the enquiry was sent to your firm, as a date and time.
clientNamestringThe client’s name.
clientEmailstringThe client’s email address.
clientPhonestringThe client’s phone number, if they gave one.
contactRevealedbooleanWhether your firm has accepted the enquiry.
contactRevealedAtstringWhen the enquiry was accepted. null until then.
messagestringThe client’s description of their legal problem, in their own words.
timeframestringHow soon the client wants help. See Timeframes. May be null.
workAreaId / workAreanumber / stringThe specific area of law the enquiry was matched to, such as Divorce.
mainWorkAreaId / mainWorkAreanumber / stringThe broader area of law it sits under, such as Family Law.
officeId / officeNamenumber / stringThe office the enquiry was sent to, if one was chosen.
professionalId / professionalNamenumber / stringThe professional the enquiry was sent to, if one was chosen.
rejectedAt, rejectReason, rejectDetailsstringSet once the enquiry is rejected. null otherwise.
reportedAt, reportReason, reportDetailsstringSet once the enquiry is reported. null otherwise.
questionsobject[]Every question the client was asked, in order, each with a question and the client’s answer. Follow-up questions appear straight after the question that prompted them. answer is null for a question the client skipped.

Enquiry statuses

StatusMeaning
SUBMITTEDNew. Your firm has been notified and has not acted yet.
CONTACTEDYour firm accepted the enquiry and is contacting the client.
UNABLE_TO_CONTACTYour firm tried to reach the client and could not get through.
TRY_CONTACTING_AGAINThe client has asked your firm to try contacting them again.
REJECTEDYour firm cannot help with the enquiry. Final.
REPORTEDYour firm reported the enquiry as invalid. Final.
COMPLETEDYour firm has finished helping the client. Final.
CLOSEDThe client closed the enquiry. Final.
TESTA test enquiry your firm sent itself. It never moves to another status.

An enquiry in a final status cannot be accepted, rejected or reported.

Timeframes

ValueThe client wants help
ASAPAs soon as possible.
PERIOD_1_2Within 1 to 2 days.
PERIOD_3_7Within 3 to 7 days.
PERIOD_7_14Within 7 to 14 days.
ANYNo particular timeframe.

Errors

CodeCause
403Client Assist is not active for your firm.
404No Client Assist enquiry with that id belongs to your firm.
Last updated on