Skip to main content
GET
Get a list of accounts

Query Parameters

currentLedgerAccounts
object | null

Filter by current ledger account identifiers

Example:
iban
string | null

Filter by IBAN

Example:

"LT643500012345678901"

page
integer<int32>

Page number (0-based)

Required range: x >= 0
Example:

0

partyId
string<uuid> | null

Filter by party ID

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
Example:

"019bdb2a-960f-789d-8955-21720e6cdeee"

size
integer<int32>

Number of items per page (max 100)

Required range: 1 <= x <= 100
Example:

20

sortBy
string
default:createdAt

Field name to sort by

Example:

"createdAt"

sortDirection
object

Sort direction

Response

Paginated list of accounts

Paginated response wrapper

data
object[]

List of items for the current page

page
integer<int32>

Current page number (0-based)

Example:

0

size
integer<int32>

Number of items per page

Example:

100

totalPages
integer<int32>

Total number of pages

Example:

5

Last modified on March 31, 2026