Skip to main content
GET
/
review-annotations
List review annotations
curl --request GET \
  --url https://api.coval.dev/v1/review-annotations \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.coval.dev/v1/review-annotations"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coval.dev/v1/review-annotations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coval.dev/v1/review-annotations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coval.dev/v1/review-annotations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/review-annotations")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/review-annotations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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
}
{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Invalid request body",
    "details": [
      {
        "field": "simulation_output_id",
        "description": "simulation_output_id is required"
      }
    ]
  }
}
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Authentication failed",
    "details": [
      {
        "field": "X-API-Key",
        "description": "Invalid or missing API key"
      }
    ]
  }
}
{
  "error": {
    "code": "INTERNAL",
    "message": "Internal server error",
    "details": [
      {
        "description": "An unexpected error occurred"
      }
    ]
  }
}

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