List venue accounts

A Company/Broker current human session, or an API key or service account with treasury_read whose owner is allowed to view wallets. Each venue account with its venue, where its funds are held, its wallets, linked accounts and execution types, each venue’s key state, and whether disabling that venue would retire its key. An account-based item’s accountId is the {venueAccountId} of GET …/venue-accounts/{venueAccountId}/balances, /deposit-history and /deposit-instructions; a walletBased item has no venue account and carries no accountId (its fundingTarget names the organisation’s trading wallets). Key items by venueEnablementId. Oldest first, paged by limit (default 20, at most 100) and the opaque cursor from the previous page’s nextCursor; nextCursor is null on the last page. A foreign or unknown path workspace answers the same 404 WORKSPACE_NOT_FOUND without reading that workspace. 400 INVALID_CURSOR for a cursor this list did not issue. 403 VENUE_READ_AUTHORITY_REFUSED when the caller’s authority to read venue accounts has ended (reason authority_ended: the credential is revoked or expired, or no longer carries treasury_read; reason permission_withdrawn: its owner lost permission to view wallets, its membership or taker admission). A session that has itself ended answers 401.

GET /api/v1/workspaces/{workspaceId}/venue-enablements

List the workspace's venue accounts

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/venue-enablements \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "integrationMode": "basic",
      "label": "<string>",
      "lifecycle": "pending",
      "providerSite": "<string>",
      "tradePaused": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "venueEnablementId": "<string>",
      "withdrawalPaused": true,
      "workspaceId": "<string>",
      "accountId": "<string>",
      "fundingTarget": {
        "accountId": "<string>",
        "kind": "venueAccount"
      },
      "revokedAt": "2023-11-07T05:31:56Z",
      "venueId": "<string>",
      "venueKind": "accountBased"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

bearer_authapi_key

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

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 from 1 to 100, default 20. A value outside that range is refused with 400 INVALID_LIMIT, never clamped.

Required range: x >= 0

Response

200

application/json

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

items · object[] · required

The workspace's venue accounts on this page. An account-based item's accountId is the {venueAccountId} of the venue-account balance and deposit reads; a wallet-based item carries none.

Show child attributes

nextCursor · string | null · required

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