Skip to main content
GET
List all accounts
Requires scope: manage:accounts — see Required scopes. Returns a paginated list of accounts. Filter by status or externalId, and page with page/size (see Pagination). Each account belongs to a party and holds wallets and virtual bank accounts.

Authorizations

FlowClient Credentials
Token URL
https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Query Parameters

externalId
string

Filter by external ID (exact match)

status
enum<string>

Filter by account status Status of an account

Available options:
ACTIVE,
SUSPENDED,
CLOSED
sortOn
string
default:createdAt

Field to sort by. When omitted, results are ordered by createdAt descending.

sortOrder
enum<string>
default:DESC

Sort direction. Applied only together with sortOn — on its own it is ignored and the default ordering (createdAt descending) is used, so ?sortOrder=ASC alone does not reverse a list.

Available options:
ASC,
DESC
page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1

Response

List of accounts

success
boolean

Indicates whether the request was successful

result
object[]
pagination
object

Pagination metadata (top-level sibling of result)