Skip to Content
Client Assist APIGETList enquiries

List enquiries

GET/api/v2/client-assist

Client Assist sends your firm enquiries from people looking for legal help. Each enquiry carries the client’s description of their problem, their contact details, and their answers to a short set of questions about it.

This endpoint returns your firm’s enquiries, newest first. Results are paginated. See Pagination.

The Client Assist API is available to active firms with an active Client Assist add-on. Any other firm receives 403 from every Client Assist endpoint.

Query parameters

ParamTypeRequiredDescription
statusstringOptionalOnly return enquiries in these statuses. Separate several with commas, for example SUBMITTED,CONTACTED. See Enquiry statuses.
workAreaIdnumberOptionalOnly return enquiries in this area of law. Matches either workAreaId or mainWorkAreaId, so a broad area such as Family Law also returns Divorce enquiries.
fromstringOptionalOnly return enquiries created on or after this date, as YYYY-MM-DD.
tostringOptionalOnly return enquiries created on or before this date, as YYYY-MM-DD. The whole day is included.
pagenumberOptionalThe page of results to return. Zero based, so the first page is 0. Defaults to 0.
sizenumberOptionalHow many enquiries to return per page. Defaults to 20, maximum 100. A larger value is treated as 100.

Request

GET /api/v2/client-assist
curl --location 'https://www.reviewsolicitors.co.uk/api/v2/client-assist?status=SUBMITTED&from=2026-08-01' \ --header 'Authorization: Bearer {access_token}'

Response

200 OK
{ "content": [ { "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" } ] } ], "page": { "size": 20, "number": 0, "totalElements": 9, "totalPages": 1 } }

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

Response fields

FieldTypeDescription
contentobject[]The enquiries on this page, newest first. See the enquiry object.
pageobjectWhere this page sits in the full result: size, number, totalElements and totalPages. See Pagination.

Errors

CodeCause
400status contains a value that is not an enquiry status, or from / to is not a YYYY-MM-DD date.
403Client Assist is not active for your firm.
Last updated on