List clients
list_clientsFetches mortgage clients or leads with pagination and date range filters, returning client cases with primary and co-applicant borrower details.
Instructions
List clients / leads. Supports paging (limit/offset) and a date range. Prefer a small limit (e.g. 25) — the unfiltered list can be very large. A client is a mortgage case with up to two borrowers: personal fields are suffixed _1 (primary) and _2 (co-applicant). Rows are under 'responseClients'. See docs/client-fields.md for the full field schema.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | From date, DD/MM/YYYY | |
| lead | No | true = leads only, false = clients | |
| limit | No | Page size, e.g. 25 | |
| until | No | Until date, DD/MM/YYYY | |
| offset | No | Page offset | |
| reference | No | ||
| range_type | No | Date range type (1/2) |