v6

OpenAPI 3.1.12026-08-027636.5 MB

Customers

List customers

List customers who have authorized an agent to act for them

get/customers

Query parameters

cursorstring

Cursor from the previous page.

limitinteger

Maximum results per page.

status'active' | 'revoked' | 'all'

Filter by connection state. Active returns any non-revoked connection (including suspended and expired). Revoked returns customers whose access was revoked. All returns both.

Headers

X-Agent-IDstring nullable

Agent (agt_*) to attribute this request to when authenticating with a party API key; omit for agent keys and agent-scoped OAuth grants, which already carry agent identity.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response