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
| Param | Type | Required | Description |
|---|---|---|---|
id | string | Required | The enquiry’s id, as returned by List enquiries. For example RS-4f1c2a9be07d3e18. |
Request
cURL
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
| Field | Type | Description |
|---|---|---|
id | string | The enquiry’s unique reference. Use it in every other Client Assist endpoint. |
status | string | Where the enquiry stands with your firm. See Enquiry statuses. |
clientAssistPlus | boolean | Whether the enquiry came through your own Client Assist+ widget or link, rather than the ReviewSolicitors site. |
createdDate | string | When the enquiry was sent to your firm, as a date and time. |
clientName | string | The client’s name. |
clientEmail | string | The client’s email address. |
clientPhone | string | The client’s phone number, if they gave one. |
contactRevealed | boolean | Whether your firm has accepted the enquiry. |
contactRevealedAt | string | When the enquiry was accepted. null until then. |
message | string | The client’s description of their legal problem, in their own words. |
timeframe | string | How soon the client wants help. See Timeframes. May be null. |
workAreaId / workArea | number / string | The specific area of law the enquiry was matched to, such as Divorce. |
mainWorkAreaId / mainWorkArea | number / string | The broader area of law it sits under, such as Family Law. |
officeId / officeName | number / string | The office the enquiry was sent to, if one was chosen. |
professionalId / professionalName | number / string | The professional the enquiry was sent to, if one was chosen. |
rejectedAt, rejectReason, rejectDetails | string | Set once the enquiry is rejected. null otherwise. |
reportedAt, reportReason, reportDetails | string | Set once the enquiry is reported. null otherwise. |
questions | object[] | 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
| Status | Meaning |
|---|---|
SUBMITTED | New. Your firm has been notified and has not acted yet. |
CONTACTED | Your firm accepted the enquiry and is contacting the client. |
UNABLE_TO_CONTACT | Your firm tried to reach the client and could not get through. |
TRY_CONTACTING_AGAIN | The client has asked your firm to try contacting them again. |
REJECTED | Your firm cannot help with the enquiry. Final. |
REPORTED | Your firm reported the enquiry as invalid. Final. |
COMPLETED | Your firm has finished helping the client. Final. |
CLOSED | The client closed the enquiry. Final. |
TEST | A 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
| Value | The client wants help |
|---|---|
ASAP | As soon as possible. |
PERIOD_1_2 | Within 1 to 2 days. |
PERIOD_3_7 | Within 3 to 7 days. |
PERIOD_7_14 | Within 7 to 14 days. |
ANY | No particular timeframe. |
Errors
| Code | Cause |
|---|---|
| 403 | Client Assist is not active for your firm. |
| 404 | No Client Assist enquiry with that id belongs to your firm. |
Last updated on