Lists all Contacts for the given tenant.
Requires: ViewAll on Contacts.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| 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) |
||
| clientCode | query string | Filter by client code - only show contacts associated with this client |
Filter by client code - only show contacts associated with this client |
||
| clientLinks | query string | Filter by client links: AnyClient (at least one), Unassigned (none) or Multiple (two or more) |
Filter by client links: AnyClient (at least one), Unassigned (none) or Multiple (two or more) |
||
| phone | query string | Find the contacts holding this phone number (main phone, mobile or any extra number). Matches with or without the country code or leading zero, and ignores spaces, dashes, brackets and extensions. At least 7 digits. Each contact comes back with every client it is linked to |
Find the contacts holding this phone number (main phone, mobile or any extra number). Matches with or without the country code or leading zero, and ignores spaces, dashes, brackets and extensions. At least 7 digits. Each contact comes back with every client it is linked to |
||
| hasEmail | query boolean | True for contacts with a main email address, false for contacts without one |
True for contacts with a main email address, false for contacts without one |
||
| isFromCompaniesHouse | query boolean | True for contacts imported from Companies House officers, false for all others |
True for contacts imported from Companies House officers, false for all others |
||
| hasPortalAccess | query boolean | True for contacts with active client portal access, false for contacts without |
True for contacts with active client portal access, false for contacts without |
||
| hasDuplicates | query boolean | True for contacts that are likely the same person as another contact, grouped by duplicateGroup, most certain groups first, each with the clients it is linked to. Paging (offset, limit, totalCount) counts groups, not contacts. False for contacts with no likely duplicates |
True for contacts that are likely the same person as another contact, grouped by duplicateGroup, most certain groups first, each with the clients it is linked to. Paging (offset, limit, totalCount) counts groups, not contacts. False for contacts with no likely duplicates |
||
| duplicateConfidence | query string | With hasDuplicates=true, only the groups of this confidence: Certain, Strong or Possible |
With hasDuplicates=true, only the groups of this confidence: Certain, Strong or Possible |
||
| duplicateMergeStatus | query string | With hasDuplicates=true, only the groups with this merge status: Ready, DetailsToChoose, CheckSamePerson or Blocked |
With hasDuplicates=true, only the groups with this merge status: Ready, DetailsToChoose, CheckSamePerson or Blocked |
||
| search | query string | Search across contact details: code, name, email, phone (minimum 3 characters) |
Search across contact details: code, name, email, phone (minimum 3 characters) |
||