Skip to main content
POST
List Check Comments
Use this API to list one check’s comments in one status, a page at a time. Each row says whether the comment is a page comment or a site comment, where it is, its status and whether it waits for a verify. See Checks Overview. Comments people attached to the check come on the first page, with attached: true and isAgent: false.

Endpoint

POST https://api.velt.dev/v2/agents/checks/comments/list

Headers

string
required
Your API key.
string
required

Body

Params

object
required
The schema uses .strict(): unknown fields are rejected.

Example Requests

1. First page of open comments

2. Next page

3. Comments one run found

Response

Success Response

limit counts agent comments. The attached comments on the first page come on top of it. A page can also hold fewer than limit comments while nextCursor is set, so keep reading until nextCursor is null.

Failure Response

Errors: INVALID_ARGUMENT (a body outside the schema: a missing ruleKey or status, a malformed ruleKey, cursor, versionId or runId, a limit outside 1..100, or an unknown field) / NOT_FOUND with CHECKS_WORKSPACE_NOT_FOUND (the workspace has no store database).