List clients
list_clientsFilter and fetch Amiqus onboarding client records by name, reference, organisation, decision status, assignee, archive state and deletion deadline.
Instructions
Clients (the people being onboarded) with name, decision status (pending/approved/rejected, or none yet), reference, retention date and timestamps. Filter by a fuzzy search on names, reference and organisation name; by status; active or archived; assignee; exact reference; deletion-date bucket; and sort by name or date. Uses GET /clients. Emails, phone numbers, dates of birth and National Insurance numbers only with include_contact_details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | API page number to start from (1-based, as documented; use next_page from a previous call) | |
| search | No | Case-insensitive fuzzy search on first, middle and last name, reference and organisation name (API parameter `search`) | |
| status | No | Only clients with this decision status (`status`) | |
| sort_by | No | Sort field (`sort_by`; ID order by default) | |
| assignee | No | Only clients assigned to this team member's user ID (`assignee`) | |
| order_by | No | Sort direction (API parameter `order_by`; ascending by default) | |
| reference | No | Exact, case-insensitive match on the client reference (`reference`) | |
| visibility | No | Only active or only archived clients (`visibility`; both by default) | |
| max_results | No | Most records to return in this call; whole API pages only (up to 100 per page), so fewer may come back with a next_page to continue from | |
| deletion_date | No | Only clients whose deletion date is in this bucket (`deletion_date`) | |
| include_contact_details | No | Include each client's email address, landline, mobile, date of birth and National Insurance number, and stop redacting emails, phone numbers, dates, postcodes and NI/NHS numbers typed into names and references. Off by default. |