Skip to main content
GET
Get agent context

Authorizations

Authorization
string
header
required

Workspace key with read ability, ad-account.read permission and the agent.context grant.

Query Parameters

account_id
integer

Optional positive account ID. A bound key may name only its own account; a different ID returns 422. An unbound key requires exactly one active available advertising account with an active connection; omission uses that account and a supplied ID must match it. Multiple active accounts return 422 even when account_id is supplied. With no active available account, a valid account_id is ignored and platform_ad_account is null.

Required range: x >= 1
workspace_id
integer

Optional workspace grant selector. Required for credentials with multiple workspace grants; it must identify an authorized workspace.

Required range: x >= 1

Response

Agent identity and account context.

meta_connected
boolean
required
agent
object
required
platform_ad_account
object | null
required
next_steps
string[]

Present only when meta_connected is false.