List Clients
Lists all Clients for the given tenant.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| 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) |
||
| status | query string | Filter clients by status |
Filter clients by status |
||
| type | query string | Filter clients by their organization type |
Filter clients by their organization type |
||
| managerCode | query string | Filter clients by their assigned manager's code |
Filter clients by their assigned manager's code |
||
| partnerCode | query string | Filter clients by their assigned partner's code |
Filter clients by their assigned partner's code |
||
| associateCode | query string | Filter clients by their assigned associate's code |
Filter clients by their assigned associate's code |
||
| serviceCode | query string | Filter clients by a specific billable service code they have assigned |
Filter clients by a specific billable service code they have assigned |
||
| 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) |
||