Skip to main content
GET
List review annotations

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
  • statusACTIVE or ARCHIVED
  • completion_statusPENDING 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