Skip to main content
GET
List venue-account credit
Walkthrough: Balances and fees.

Authorizations

Authorization
string
header
required

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

Scopes

treasury_read
bearer_auth
treasury_read
api_key

Headers

TetraFi-Version
enum<string>

The dated API version to answer this request in. Without it, an API key's requests use the version the key pinned when it was created, and a member session uses the current version. A value that is not exactly one supported date answers 400 API_VERSION_UNSUPPORTED before anything runs. The response's TetraFi-Version header names the version used.

Available options:
2026-11-17

Path Parameters

workspaceId
string
required

Current company or broker workspace

Query Parameters

venueAccountId
string

Only these venue accounts, comma-separated (any of, at most 100). Without it, every venue account of the workspace that settles through a venue account.

include
string

consumers expands every listed account's commitment rows under the page's included.consumers[venueAccountId], as on the item read.

limit
integer<int32>

Page size, 1 to 100 (default 20); any other value is 400 INVALID_LIMIT.

Required range: x >= 0
cursor
string

The nextCursor of the previous page of this list.

Response

One page of venue-account credit.

items
object[]
required
nextCursor
string | null
required
unreachable
object[]
required

Accounts on this page whose credit could not be read: one entry each, source venueAccounts/<venueAccountId>, reason that account's refusal code (the item read's error, such as VENUE_ACCOUNT_NOT_FOUND for an asked account this workspace does not hold). The other accounts are still listed; an unread account is never a zero standing.

included
null | object

With include=consumers: every listed account's commitment rows under included.consumers[venueAccountId], as the item read expands them; omitted otherwise.