List plans
list_plansFetch financial plans (pensions, investments, mortgages) with filters for type, provider, status, and owners. Returns review dates and advice status; excludes valuations and money amounts.
Instructions
Plans (pensions, investments, protection, mortgages and other products) with type, provider, status, owners by name, review date and whether they are under advice, filtered as GET /api/v1/plans documents. Policy numbers only with include_contact_details; valuations and other money amounts are not returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Plan name, partial match (filter[name]) | |
| sort | No | Sort field; prefix with - for descending. The API's default is name. | |
| types | No | filter[type] | |
| provider | No | Provider name (partial) or provider UUID (filter[provider]) | |
| statuses | No | filter[status] | |
| max_results | No | Most records to return; lists are fetched 100 per request, up to 10 requests | |
| client_uuids | No | Only plans of these clients (filter[account_uuids]) | |
| under_advice | No | filter[under_advice] | |
| abstract_types | No | filter[abstract_type] | |
| household_uuids | No | Only plans of these circles (filter[circle_uuids]) | |
| include_contact_details | No | Include policy and proposal numbers, owners' email addresses, and unredacted emails, phone numbers and postcodes in plan and owner names. Off by default. |