VocalDocscontracts 1.65.0

List the capture windows of an Agent

GET /v1/agents/{agent_id}/capture-windows

PropertyValue
Operationlist_capture_windows
GroupCapture windows and reveal grants
Scopeagents:write
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; the list leaves the reason out.
Released in1.57.0
Phase 0 hostServed (the hosted api pins 1.65.0)

The capture windows of the Agent, newest first, with keyset pagination (1.57.0), each without its reason.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the agents:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/agents/agt_.../capture-windows" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
agent_idpathAgentIdyesThe id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
statusqueryCaptureWindowStatusnoOnly the windows in this status.

Responses

StatusContent typeShapeError codes
200application/jsonCaptureWindowList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is CaptureWindowList.

FieldTypeRequiredDescription
dataarray of CaptureWindowyesThe capture windows of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes