Skip to main content
GET
Get an agent's relationships
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/getRelationships?id=<agentId> returns who and what one agent is connected to, as the Console’s agent detail relationships card shows it.

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, or a grant that cannot be decided, is 500. id is required once.

What it returns

Each part is decided where it lives, and only when your credential’s scopes also reach that part’s key (a token scoped to agents:read alone sees none of the three, whatever its role grants hold): workflows lists the workflows whose active version uses the agent (workflowsTruncated is true past the read bound).

What is withheld

owner is only { present, active }: whether the agent has an owner and whether that owner is an active person. Never the owner’s person id or name, the same rule the governance accountability read follows. See Get an agent’s accountability.

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

Get an agent's relationships

data
object
required
meta
object
required