API Reference Comments

List Check Comments

GEThttps://api-v2.crosscheck.cloud/api/v1/checks/{id}/comments

List comments on a check in chronological order, with author details.

Authentication

Send a valid Crosscheck session JWT in the Authorization: Bearer YOUR_SESSION_TOKEN header. Workspace endpoints use the active workspace in your session. MCP OAuth tokens are not accepted here.

Path Parameters

idstringrequired

The check UUID.

Headers

Accept

JSON request and response format.

application/json

Authorization

A valid session JWT from Crosscheck authentication.

Bearer YOUR_SESSION_TOKEN

Responses

200 OK

`id`string · uuid	Unique comment identifier.
`checkId`string · uuid	Check the comment belongs to.
`body`string	Comment text.
`createdBy`string · uuid	Comment author identifier.
`timestamp`number \| null	Position in a recording.
`imagePoint`object \| null	Normalized image coordinates, x and y from 0 to 1.
`author`object	Author profile and email.

400 Invalid request

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

401 Authentication required

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

403 Insufficient permissions

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

404 Resource not found

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

Selected fields and abbreviated examples are shown. Additional fields and error codes depend on the resource, permissions, plan and retention state.