Skip to main content
GET
Get an agent's open setup request
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/getSetupRequest?id=<agentId> returns the agent’s open setup request: the readiness gaps it asks people to fix (checkIds), how many people it asks (audienceCount), and when it was sent (requestedAt), with its requestId.

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 agent store is 500. id is required once.

When there is none

data is null when no setup request is open, and also when the agent is ready now: a request whose gaps are fixed, or that asks about gaps the agent no longer has, is not returned. 404 is only ever about the agent.

What is withheld

The people a request asks are never returned, only their count. Ask for setup with POST /api/v2/agents/requestSetup; marking it done stays in the Console.

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 open setup request

data
object | null
required
meta
object
required