List landlords with financial summaries

Returns a paginated list of all landlord profiles with their computed financial summaries.

Overview

This endpoint provides an aggregated view of landlord financial data, including cash balance,
retained provisions, managed assets count, and pending payment orders. It eliminates the need
to reconstruct these values from individual accounting accounts.

Fields

  • cash_balance_in_cents: Available funds (credit - debit on landlord third-party accounts),
    prorated for co-ownership. Negative means the landlord has a debit balance.
  • retained_provisions_in_cents: Funds held as retained provisions (not included in cash_balance).
  • managed_assets_count: Total number of assets and asset groups across all management contracts.
  • pending_payment_orders_count / pending_payment_orders_total_in_cents: Payment orders
    with status pending or approved.

Filtering

  • balance_status=debtor: Only landlords with negative cash balance
  • balance_status=creditor: Only landlords with zero or positive cash balance

Sorting

  • sort_by=reference (default): Sort by profile reference
  • sort_by=cash_balance: Sort by cash balance (combine with sort_direction=asc or desc)

Performance note

When filtering by balance_status or sorting by cash_balance, the endpoint computes balances
for all landlords before paginating. Without these parameters, standard SQL pagination is used.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number for pagination (default: 1)

integer

Number of items per page (default: 10, max: 100)

string
enum

Filter by balance status: debtor (negative balance) or creditor (zero or positive)

Allowed:
string
enum

Sort field: reference (default) or cash_balance

Allowed:
string
enum

Sort direction when sort_by=cash_balance: asc (default) or desc

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json