Skip to main content
GET
List an agent's tool and capability 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/listGrants?id=<agentId> returns one agent’s tool grants, tool-set rows and permitted capability set, as the Console’s agent capability tab and the workflow editor’s capability picker show 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

  • tools: the tools granted to the agent one by one, { toolId, name, mode: "grant" }.
  • toolSets: the tool sets granted to or denied to the agent, { setId, name, mode }.
  • permitted: what the agent may use when it runs, as dispatch resolves it: skills (granted minus denied, skill sets expanded), toolSets, and externalTools of the runtime types a run can bind.
Tools, tool sets and skills are platform-wide, so rows carry their natural keys, never an assignment or definition id. A grant whose tool or set no longer exists is left out. permitted is the set dispatch itself resolves, so a fault in that resolver’s store shows a shorter set rather than a 500.

Bounds

Each list holds at most 500 rows. meta.partial is true when one was cut.

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

Response

List an agent's tool and capability grants

data
object
required
meta
object
required