Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Agent-ID
string | null

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.

Maximum string length: 36
Pattern: ^agt_[0-9a-f]{32}$
X-Instance-ID
string | null

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

Maximum string length: 1024

Query Parameters

cursor
string

Cursor from the previous page.

Maximum string length: 1024
limit
integer
default:20

Maximum results per page.

Required range: 1 <= x <= 100
status
enum<string>
default:active

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

Available options:
active,
revoked,
all

Response

Successful Response

data
CustomerActiveResource · object[]
required
meta
object
required