get
https://rivage.immo/api/v1/landlords
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 balancebalance_status=creditor: Only landlords with zero or positive cash balance
Sorting
sort_by=reference(default): Sort by profile referencesort_by=cash_balance: Sort by cash balance (combine withsort_direction=ascordesc)
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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
