Skip to main content
GET
List all parties
Returns a paginated list of parties. Filter by partyType, status, or externalId, and page with page/size (see Pagination). A party is the root entity in the Finance API — each one can hold one or more accounts.

Authorizations

Query Parameters

partyType
enum<string>

Filter by party type Type of party

Available options:
INDIVIDUAL,
ORGANISATION
status
enum<string>

Filter by party status Status of a party

Available options:
ACTIVE,
SUSPENDED,
BLOCKED
externalId
string

Filter by external ID (exact match)

sortOn
string
default:createdAt

Field to sort by

sortOrder
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC
page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1

Response

List of parties

success
boolean

Indicates whether the request was successful

result
object[]
pagination
object

Pagination metadata (top-level sibling of result)