Search clients
search_clientsFind and filter a financial firm's clients by name, role, prospect flag, status, tags, assigned adviser, or household; optionally return email and phone.
Instructions
Search the firm's accounts (clients by default) by name, role, prospect flag, status, tags, assigned adviser or household, with the documented filters of GET /api/v1/account. Each result has the UUID, name, type and role, assigned adviser, review dates, tags and households. Email and phone only with include_contact_details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Partial match against first name, last name and entity name (filter[name]) | |
| sort | No | Sort field; prefix with - for descending. The API's default is first_name. | |
| tags | No | Tag names or tag UUIDs (filter[tags]) | |
| type | No | Account type (filter[type]) | client |
| roles | No | Account roles (filter[role]) | |
| status | No | Client status, a partial name or a status UUID (filter[status]) | |
| is_prospect | No | Only prospects (true) or only non-prospects (false) (filter[is_prospect]) | |
| max_results | No | Most records to return; lists are fetched 100 per request, up to 10 requests | |
| household_uuids | No | Only accounts in these households/circles (filter[circle_uuids]) | |
| assigned_adviser_uuids | No | Only clients of these advisers (filter[assigned_adviser_uuids]) | |
| include_contact_details | No | Include email addresses and primary phone numbers, and stop redacting emails, phone numbers and postcodes typed into names. Off by default. |