Skip to main content
GET
List the workspace's venue accounts

Authorizations

Authorization
string
header
required

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

Headers

X-Workspace-Id
string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId
string
required

Current company or broker workspace

Query Parameters

cursor
string

Opaque nextCursor from the previous page of the same list and filters.

limit
integer<int32>

Page size, default 20, clamped to 1..=100.

Required range: x >= 0

Response

One page of the workspace's venue accounts, oldest first.

items
object[]
required

The workspace's venue accounts on this page. Each item's accountId is the {venueAccountId} of the venue-account balance and deposit reads.

nextCursor
string | null
required

Pass as cursor for the next page; explicit null marks the last page.