VocalDocscontracts 1.65.0

List reveal grants

GET /v1/reveal-grants

PropertyValue
Operationlist_reveal_grants
GroupCapture windows and reveal grants
Scopereveal_grants:read
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 Organization's reveal grants, newest first, each without its reason (1.57.0): every grant for an owner or auditor, for the access review, and its own requests for any other Member.

Request

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

curl "$VOCAL_API/v1/reveal-grants" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
statusqueryRevealGrantStatusnoOnly the grants in this status.
requested_byqueryMemberIdnoOnly the grants this Member requested.

Responses

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

Fields of the 200 answer

The shape is RevealGrantList.

FieldTypeRequiredDescription
dataarray of RevealGrantyesThe reveal grants 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