List cases
list_casesList and filter cases such as pension transfers or mortgages by client, household, employee, status, type, or date ranges to monitor progress and reviews.
Instructions
Cases (pieces of advice work such as a pension transfer or a mortgage) with type, status, review date, completion and participants by name, filtered as GET /api/v1/cases documents: by client, household, employee, progress, review or completion date range, status or type. Case values are not returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort field; prefix with - for descending. The API's default is name. | |
| statuses | No | Case statuses (filter[status]) | |
| completed | No | filter[completed] | |
| type_uuids | No | Case type UUIDs (filter[type]) | |
| in_progress | No | filter[in_progress] | |
| max_results | No | Most records to return; lists are fetched 100 per request, up to 10 requests | |
| client_uuids | No | Only cases for these accounts (filter[account_uuids]) | |
| review_after | No | Only cases with a review date after this (filter[review_at_after]) | |
| review_before | No | Only cases with a review date before this (filter[review_at_before]) | |
| employee_uuids | No | Only cases for these employees (filter[employee_account_uuids]) | |
| completed_after | No | filter[completed_after] | |
| household_uuids | No | Only cases for these circles (filter[circle_uuids]) | |
| completed_before | No | filter[completed_before] | |
| include_contact_details | No | Include participants' email addresses, and stop redacting emails, phone numbers and postcodes typed into case and participant names. Off by default. |