Skip to main content
GET
List an agent's procedure grants
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/agents/listProcedureGrants?id=<agentId> lists the procedures granted to, or denied to, one agent, oldest assignment first, as the Console’s agent capability tab lists them.

Authority

You need agents:read at the agent’s home org unit. A missing, PERSONAL, unhomed or unreadable agent is the same 404 resource_missing (Agent not found); an unavailable store is 500. id is required once.

What it returns

Each row is { procedureId, name, mode, assignedAt }: the procedure’s slug, whether it is a grant or a deny, and when it was assigned. name is the procedure’s active version’s display name (else its highest version’s) where your credential’s scopes reach workflows:read and you hold it at that version’s home; otherwise it is null, as the Console shows the slug. A procedure that no longer exists is not listed.

Paging

The grants come a page at a time, oldest assignment first: limit is 1-200, default 200, and a larger value is 400 too_big. While meta.hasMore is true, pass meta.nextCursor as cursor with the same id; a cursor from another route, another agent or another credential, or altered, is 400. A procedure that no longer exists is left out after the read, so a page may hold fewer than limit while more remain. The list never answers meta.partial.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

agentId
string
required

The agent's slug (agentId) or definition id.

Minimum string length: 1

Query Parameters

limit
integer
default:200

Items per page, 1 to 200 (default 200); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 200
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

List an agent's procedure grants

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.