List Contacts
Lists all Contacts for the given tenant.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The tenant code (the organisation's URL stub) |
The tenant code (the organisation's URL stub) |
||
| 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. Valid values depend on the resource. |
Field to sort by. Valid values depend on the resource. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||
| search | query string | Search contacts by name, code or email address, and subcontractors by UTR, NI number, company number or trading name. Terms shorter than 3 characters are ignored. |
Search contacts by name, code or email address, and subcontractors by UTR, NI number, company number or trading name. Terms shorter than 3 characters are ignored. |
||
| role | query string | Only contacts with this role: Customer (invoiced by the tenant), Supplier (invoices the tenant; includes CIS subcontractors) or CisSubcontractor. Omitted: all contacts. |
Only contacts with this role: Customer (invoiced by the tenant), Supplier (invoices the tenant; includes CIS subcontractors) or CisSubcontractor. Omitted: all contacts. |
||
| verificationStatus | query string | Only CIS subcontractors with this verification status (Verified, NotVerified, Error). Contacts without the subcontractor role never match. |
Only CIS subcontractors with this verification status (Verified, NotVerified, Error). Contacts without the subcontractor role never match. |
||