Skip to main content
GET
List a venue account's settlement schedules
Walkthrough: Credit and settlement.

Authorizations

Authorization
string
header
required

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

Scopes

settlements_read
bearer_auth
settlements_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

Workspace id

venueAccountId
string
required

The venue account's id

Query Parameters

limit
integer<int32>

Page size from 1 to 100, default 20; anything else is 400 INVALID_LIMIT.

Required range: x >= 0
cursor
string

The previous page's nextCursor.

Response

One page of the LP's published settlement schedules for a venue account, ordered by schedule id then version. The selected version stays listed after a newer one is published.

items
object[]
required
nextCursor
string | null
required

Signed cursor for the next page; null on the last page.