Get a review request

GET/api/v2/review-requests/{matterReference}

Returns a review request and the status of every attempt to reach the client, looked up by the reference you sent when you created it.

Path parameters

Param	Type	Required	Description
`matterReference`	`string`	Required	The `reference` the review request was created with.

Request

cURL

GET /api/v2/review-requests/{matterReference}


curl --location 'https://www.reviewsolicitors.co.uk/api/v2/review-requests/{matterReference}' \
     --header 'Authorization: Bearer {access_token}'

Response

200 OK


{
  "matterReference": "MATTER-1234",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phoneNumber": "07700900123",
  "professional": "Alex Smith",
  "workArea": "Conveyancing",
  "language": "EN",
  "createdDate": "2026-01-31T09:30:00",
  "reviewLeft": false,
  "reviewText": null,
  "reviewRequestAttempts": [
    {
      "status": "OPENED",
      "statusTimestamp": "2026-01-31T11:02:00",
      "template": "TYPE_1",
      "statusHistory": [
        { "status": "PENDING", "dateTime": "2026-01-31T09:30:00" },
        { "status": "SENT", "dateTime": "2026-01-31T10:00:00" },
        { "status": "DELIVERED", "dateTime": "2026-01-31T10:00:05" },
        { "status": "OPENED", "dateTime": "2026-01-31T11:02:00" }
      ]
    },
    {
      "status": "PENDING",
      "statusTimestamp": null,
      "template": "TYPE_2",
      "statusHistory": []
    }
  ]
}

The review request object

Field	Type	Description
`matterReference`	`string`	The `reference` the review request was created with.
`firstName`	`string`	The client first name.
`lastName`	`string`	The client last name.
`email`	`string`	The client email address.
`phoneNumber`	`string`	The client phone number, if one was given.
`professional`	`string`	The name of the professional linked to the request.
`workArea`	`string`	The area of law the matter relates to.
`language`	`string`	The language code the invitation was sent in. See Language codes.
`createdDate`	`string`	When the review request was created, as a date and time.
`reviewLeft`	`boolean`	Whether the client has left a review.
`reviewText`	`string`	Your firm’s reply to the resulting review, if one has been posted.
`reviewRequestAttempts`	`object[]`	Every attempt to reach the client, in order. See below.

The attempt object

A review request is sent as a series of attempts: the first invitation, then any reminders.

Field	Type	Description
`status`	`string`	Where the attempt is now. See Attempt statuses.
`statusTimestamp`	`string`	When the attempt reached its current status. `null` until it is sent.
`template`	`string`	The message template used. `TYPE_1` to `TYPE_9` are emails, `SMS_1` to `SMS_3` are phone messages, sent by SMS or WhatsApp.
`statusHistory`	`object[]`	Every status the attempt has passed through, each with a `status` and a `dateTime`.

Attempt statuses

Status	Meaning
`PENDING`	Scheduled and waiting to be sent.
`SENT`	Sent to the client.
`DELIVERED`	Delivered to the client’s inbox or phone.
`OPENED`	The client opened the email, or read the WhatsApp message.
`CLICKED`	The client followed the link.
`REVIEW_LEFT`	The client left a review.
`FEEDBACK_LEFT`	The client left feedback.
`GOOGLE_REVIEW`	The client was routed to leave a Google review instead.
`CANCELLED_BY_REVIEW`	Cancelled because a review was left, or because the request was cancelled.
`CANCELLED_BY_ADMIN`	Cancelled by an administrator.
`BLOCKED`	The email or SMS provider permanently refused the recipient.
`FAILED`	Sending failed.

Errors

Code	Cause
404	No review request with that `matterReference` belongs to your firm.