Skip to main content
GET
Get All Settlements

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Query Parameters

statusFilter
enum<string>
Available options:
pending,
completed,
all
page
integer
Example:

1

pageSize
integer
Example:

50

Response

Settlement history

settlements
object[]
total
number
Example:

150

page
number
Example:

1

pageSize
number
Example:

50

hasMore
boolean
Example:

true