Skip to main content
GET
/
v1
/
review-annotations
List review annotations
curl --request GET \
  --url https://api.coval.dev/v1/review-annotations \
  --header 'X-API-Key: <api-key>'
{
  "review_annotations": [
    {
      "name": "review-annotations/abc123def456ghi789jklm",
      "id": "abc123def456ghi789jklm",
      "simulation_output_id": "sim-output-001",
      "metric_id": "metric-accuracy",
      "assignee": "alice@company.com",
      "ground_truth_float_value": null,
      "ground_truth_string_value": null,
      "reviewer_notes": null,
      "status": "ACTIVE",
      "completion_status": "PENDING",
      "priority": "PRIORITY_STANDARD",
      "create_time": "2026-01-15T12:00:00Z",
      "update_time": "2026-01-15T12:00:00Z"
    }
  ],
  "next_page_token": null
}

Authorizations

​
X-API-Key
string
header
required

Organization API key for authentication

Query Parameters

​
page_size
integer
default:50

Maximum number of results per page

Required range: 1 <= x <= 100
​
page_token
string

Opaque pagination token from previous response

​
order_by
string

Sort field and direction. Prefix with - for descending. Valid fields: create_time, update_time, assignee, priority.

Example:

"-create_time"

​
filter
string

Filter expression. Supported fields:

  • simulation_output_id — exact match
  • metric_id — exact match
  • assignee — exact match
  • status — ACTIVE or ARCHIVED
  • completion_status — PENDING or COMPLETED
  • project_id — annotations belonging to a project

Response

Annotations retrieved successfully

​
review_annotations
object[]
required
​
next_page_token
string | null

Opaque token for fetching the next page