api.accounts.list
List every account the org has attached across all of its end-user customers. Optionally filter by customer, kind, origin, currency, rail, status.
const = await ..();
// Filter to a single customer.
const = await ..({
: "2f10…",
});
// Active USDC-capable crypto accounts.
const = await ..({
: "crypto",
: "USDC",
: "active",
});Arguments
| Param | Type | Notes |
|---|---|---|
customer_id | string? | Narrow to a single customer. |
kind | "fiat" | "crypto"? | Narrow to one kind. |
origin | "external" | "virtual"? | Narrow to one origin. |
currency | string? | Currency name or numeric id. |
rail | string? | Rail name or numeric id. |
status | "pending" | "active" | "failed" | "closed"? | Match exactly. closed returns retired accounts, which carry no details. |
limit | integer (1–200, default 50)? | Page size. |
cursor | string? | Opaque cursor from the prior page's next_cursor. |
Returns: Promise<Account[]>.
REST endpoint: GET /accounts.
