List Clients
Lists Clients for the given tenant.
Supports filtering by manager, partner, associate, status, type, service, and search term.
Optionally apply a saved filter by code — saved filter values are used unless explicitly overridden by query parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| savedFilter | query string | Code of a saved filter to apply. When provided, all filter parameters from the saved filter are used unless explicitly overridden by query parameters. |
Code of a saved filter to apply. When provided, all filter parameters from the saved filter are used unless explicitly overridden by query parameters. |
||
| offset | query integer (int32) | Number of records to skip (default: 0). Use with limit for pagination. |
Number of records to skip (default: 0). Use with limit for pagination. |
||
| limit | query integer (int32) | Maximum number of records to return (default: 10, max: 50) |
Maximum number of records to return (default: 10, max: 50) |
||
| sortBy | query enum | Field to sort by. |
Field to sort by. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||
| managerCode | query array | Filter clients by their assigned manager's code (repeat parameter for multiple values) |
Filter clients by their assigned manager's code (repeat parameter for multiple values) |
||
| partnerCode | query array | Filter clients by their assigned partner's code (repeat parameter for multiple values) |
Filter clients by their assigned partner's code (repeat parameter for multiple values) |
||
| associateCode | query array | Filter clients by their assigned associate's code (repeat parameter for multiple values) |
Filter clients by their assigned associate's code (repeat parameter for multiple values) |
||
| status | query array | Filter clients by status (repeat parameter for multiple values) |
Filter clients by status (repeat parameter for multiple values) |
||
| type | query array | Filter clients by their organization type (repeat parameter for multiple values) |
Filter clients by their organization type (repeat parameter for multiple values) |
||
| serviceCode | query array | Filter clients by billable service codes they have assigned (repeat parameter for multiple values) |
Filter clients by billable service codes they have assigned (repeat parameter for multiple values) |
||
| search | query string | Search across client code, name and internal reference (minimum 3 characters) |
Search across client code, name and internal reference (minimum 3 characters) |
||