ContractContacts
Search ContractContacts
Search and list ContractContact records with filtering, sorting, and pagination.
GET
A ContractContact is a key contact entry on a virtual office contract (
CoworkerContract). Contacts can be directors, company aliases, or nominated recipients, and are used to identify, validate, and handle mail and deliveries addressed to anyone connected to a virtual office contract.
Each entry can be linked to an existing coworker via CoworkerId, in which case the coworker’s name and email are resolved automatically. Alternatively, provide FullName and Email directly for contacts who do not have a coworker record.
Use ContractContactType to classify the contact:
| Type | Description |
|---|---|
Director | A director of the company registered under the virtual office contract |
CompanyAlias | A trading name or alias used by the company |
NominatedRecipient | A person authorised to receive mail and deliveries on behalf of the company |
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ContractContact-List role.Enums
eContractContactType — ContractContactType values
eContractContactType — ContractContactType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | Director |
| 2 | CompanyAlias |
| 3 | NominatedRecipient |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Coworker Contract Id.
Filter by Coworker Contract Quantity.
Filter by Coworker Contract Floor Plan Desk Ids.
Filter by Coworker Contract Floor Plan Desk Names.
Filter by plan name of the associated virtual office contract.
Filter by Coworker Id.
Filter by full name of the linked coworker.
Filter by company name of the linked coworker.
Filter by billing name of the linked coworker.
Filter by email address of the linked coworker.
Filter by Coworker Active.
Filter by email address of the contact. Used when the contact is not linked to a coworker record.
Filter by full name of the contact. Used when the contact is not linked to a coworker record.
Filter by date of birth. Used for identity verification purposes.
Filter by address.
Filter by post code.
Filter by city name.
Filter by state.
Filter by Country Id.
Filter by country name.
Filter by phone number.
Filter by notes.
Filter by role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company).
Range Filters
Filter by coworker contract quantity greater than or equal to this value.
Filter by coworker contract quantity less than or equal to this value.
Filter by date of birth. Used for identity verification purposes greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date of birth. Used for identity verification purposes less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by FullName
Range filters
Response
200
The list of ContractContact records matching the query. See the Get one ContractContact endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response