Get AI Reviews

GET

/api/v1/workspaces/{workspace_id}/emails/{id}/ai_reviews

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/ai_reviews';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/ai_reviews \
  --header 'Authorization: Bearer <token>'

Retrieves the AI reviews for an email.

Authorizations

OAuth2
ai_reviews:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

Email ID

Responses

200

Successful

application/json

object

results

required

Array<object>

object

required

integer

email_id

required

integer

ai_reviewer_id

required

integer

requested_by_id

required

integer

status

required

string

Allowed values: in_progress completed failed

created_at

required

string format: date-time

ended_at

required

string format: date-time

nullable

ai_reviewer

required

object

required

integer

name

required

string

Example

{
  "results": [
    {
      "id": 12345,
      "email_id": 12345,
      "ai_reviewer_id": 67890,
      "requested_by_id": 12345,
      "status": "in_progress",
      "created_at": "2026-03-20T10:30:00.000Z",
      "ended_at": "2026-03-20T10:32:00.000Z",
      "ai_reviewer": {
        "id": 67890,
        "name": "Spellcheck Bot"
      }
    }
  ]
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}