Skip to navigation
API BaaSAccounts

List the accounts enabled for the tenant

Returns the accounts of the tenant in X-Tenant-Id, one page at a time, each with its status. Use it to discover accountId before calling account routes. The status is the one recorded for the account (active, blocked, suspended, closed, pending, integrating, failed), including closed; filter with status when you only want one.

page starts at 1. size defaults to 50 and is capped at 100: a larger value is not an error, the page comes back with size: 100. Pages are ordered by creation time, newest first, and stay stable between calls.

Requires the read scope. A credential restricted to specific accounts only sees those accounts, and total counts only them. The response does not include balances.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

pageintegerOptional>=1Defaults to 1

1-based page number. page=1 is the first page. A missing or smaller value is treated as 1.

sizeintegerOptional1-100Defaults to 50
Page size, up to 100. Values above 100 are capped at 100. Missing or smaller than 1 falls back to 50.
statusenumOptional

When set, only accounts in this status. Omitted returns every status, including closed.

Response

One page of the tenant's accounts.
tenantIdstring

Tenant from X-Tenant-Id.

itemslist of objects
Accounts on this page, newest first.
totalinteger
Accounts matching the filter, across every page. Respects a credential restricted to specific accounts.
pageinteger

1-based page number that was returned.

sizeinteger
Page size that was applied, after the cap of 100.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error