Skip to main content
GET
/
parties
List all parties
curl --request GET \
  --url https://api.venlyfinance.com/v1/parties \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "result": [
    {
      "id": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
      "externalId": "user-12345",
      "partyType": "INDIVIDUAL",
      "status": "ACTIVE",
      "firstName": "Jane",
      "lastName": "Doe",
      "createdAt": "2026-01-15T09:30:00"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 20,
    "numberOfElements": 1,
    "numberOfPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}
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

​
Authorization
string
header
required

OAuth2 client credentials flow. Token endpoints:

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)