Skip to main content
GET
/
accounts
Retrieve all accounts
curl --request GET \
  --url https://api.brale.xyz/accounts \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
    "name": "ABC Company",
    "status": "complete",
    "created": "2026-01-01T00:00:00Z",
    "updated": "2026-01-01T00:00:00Z"
  }
]
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.
Account creation requires KYB / business details (see Create a customer account), but account list responses return only this account summary for each account and do not include sensitive KYB details.

Response shape

GET /accounts returns a JSON array of Account summary objects. Each element matches the Retrieve a customer account shape.

Example

Response
[
  {
    "id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
    "name": "ABC Company",
    "status": "complete",
    "created": "2026-01-01T00:00:00Z",
    "updated": "2026-01-01T00:00:00Z"
  },
  {
    "id": "34lCJZ2bxbPAzB3ou67Md01veUo",
    "name": "Managed Account Beta",
    "status": "pending",
    "created": "2026-01-15T12:00:00Z",
    "updated": "2026-01-15T12:00:00Z"
  }
]

Authorizations

Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Response

200 - */*

An array of accounts

id
string<ksuid>
required
Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

name
string
required

Account / business display name returned by the API.

Example:

"ABC Company"

status
enum<string>
required

KYB / onboarding status of the account.

Available options:
complete,
pending,
rejected
Example:

"complete"

created
string<date-time>

When the account was created.

Example:

"2026-01-01T00:00:00Z"

updated
string<date-time>

When the account was last updated.

Example:

"2026-01-01T00:00:00Z"