> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search ContractContacts

> Search and list ContractContact records with filtering, sorting, and pagination.

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

<Note>
  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.
</Note>

## Enums

<Accordion title="eContractContactType — ContractContactType values">
  | Value | Name               |
  | ----- | ------------------ |
  | 0     | None               |
  | 1     | Director           |
  | 2     | CompanyAlias       |
  | 3     | NominatedRecipient |
</Accordion>

<Accordion title="eAmlCheckStatus — AmlCheckStatus values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | NotStarted      |
  | 1     | Pending         |
  | 2     | Clear           |
  | 3     | PotentialMatch  |
  | 4     | ConfirmedMatch  |
  | 5     | Error           |
  | 6     | ManuallyCleared |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="ContractContact_CoworkerContract" type="integer">
  Filter by iD of the coworker contract linked to this record.
</ParamField>

<ParamField query="ContractContact_CoworkerContract_Quantity" type="integer">
  Filter by the coworker contract quantity value for this contract contact.
</ParamField>

<ParamField query="ContractContact_CoworkerContract_FloorPlanDeskIds" type="string">
  Filter by the coworker contract floor plan desk ids value for this contract contact.
</ParamField>

<ParamField query="ContractContact_CoworkerContract_FloorPlanDeskNames" type="string">
  Filter by the coworker contract floor plan desk names value for this contract contact.
</ParamField>

<ParamField query="ContractContact_CoworkerContract_Tariff_Name" type="string">
  Filter by plan name of the associated virtual office contract.
</ParamField>

<ParamField query="ContractContact_Coworker" type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField query="ContractContact_Coworker_FullName" type="string">
  Filter by full name of the linked coworker.
</ParamField>

<ParamField query="ContractContact_Coworker_CompanyName" type="string">
  Filter by company name of the linked coworker.
</ParamField>

<ParamField query="ContractContact_Coworker_BillingName" type="string">
  Filter by billing name of the linked coworker.
</ParamField>

<ParamField query="ContractContact_Coworker_Email" type="string">
  Filter by email address of the linked coworker.
</ParamField>

<ParamField query="ContractContact_Coworker_Active" type="boolean">
  Filter by whether coworker active is enabled.
</ParamField>

<ParamField query="ContractContact_Email" type="string">
  Filter by email address of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField query="ContractContact_FullName" type="string">
  Filter by full name of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField query="ContractContact_DateOfBirth" type="string">
  Filter by date of birth. Used for identity verification purposes.
</ParamField>

<ParamField query="ContractContact_Address" type="string">
  Filter by street address.
</ParamField>

<ParamField query="ContractContact_PostCode" type="string">
  Filter by post code.
</ParamField>

<ParamField query="ContractContact_CityName" type="string">
  Filter by city name.
</ParamField>

<ParamField query="ContractContact_State" type="string">
  Filter by state or province.
</ParamField>

<ParamField query="ContractContact_Country" type="integer">
  Filter by iD of the country linked to this record.
</ParamField>

<ParamField query="ContractContact_Country_Name" type="string">
  Filter by country name.
</ParamField>

<ParamField query="ContractContact_PhoneNumber" type="string">
  Filter by phone number.
</ParamField>

<ParamField query="ContractContact_Notes" type="string">
  Filter by optional notes or comments about this contract contact.
</ParamField>

<ParamField query="ContractContact_ContractContactType" type="integer">
  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).
</ParamField>

<ParamField query="ContractContact_AmlCheckStatus" type="integer">
  Filter by the AML check status for this contact.
</ParamField>

<ParamField query="ContractContact_AmlCheckDate" type="string">
  Filter by the date when the AML check was performed.
</ParamField>

<ParamField query="ContractContact_AmlOpenSanctionsScore" type="number">
  Filter by the score from the open sanctions check.
</ParamField>

<ParamField query="ContractContact_AmlOpenSanctionsResponse" type="string">
  Filter by the response from the open sanctions check as JSON string.
</ParamField>

<ParamField query="ContractContact_AmlPappersResponse" type="string">
  Filter by the response from the Pappers AML check as TEXT string.
</ParamField>

<ParamField query="ContractContact_AmlPappersStatus" type="string">
  Filter by the status from the Pappers AML check.
</ParamField>

<ParamField query="ContractContact_AmlNotes" type="string">
  Filter by notes related to the AML check. Customers cannot see this field, it's for internal use only.
</ParamField>

<ParamField query="ContractContact_AmlClearedBy" type="string">
  Filter by the user who cleared the AML check.
</ParamField>

<ParamField query="ContractContact_AmlClearedOn" type="string">
  Filter by the date when the AML check was cleared.
</ParamField>

### Range Filters

<ParamField query="from_ContractContact_CoworkerContractQuantity" type="integer">
  Filter by the coworker contract quantity value for this contract contact greater than or equal to this value.
</ParamField>

<ParamField query="to_ContractContact_CoworkerContractQuantity" type="integer">
  Filter by the coworker contract quantity value for this contract contact less than or equal to this value.
</ParamField>

<ParamField query="from_ContractContact_DateOfBirth" type="string">
  Filter by date of birth. Used for identity verification purposes greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractContact_DateOfBirth" type="string">
  Filter by date of birth. Used for identity verification purposes less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ContractContact_AmlCheckDate" type="string">
  Filter by the date when the AML check was performed greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractContact_AmlCheckDate" type="string">
  Filter by the date when the AML check was performed less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ContractContact_AmlOpenSanctionsScore" type="number">
  Filter by the score from the open sanctions check greater than or equal to this value.
</ParamField>

<ParamField query="to_ContractContact_AmlOpenSanctionsScore" type="number">
  Filter by the score from the open sanctions check less than or equal to this value.
</ParamField>

<ParamField query="from_ContractContact_AmlClearedOn" type="string">
  Filter by the date when the AML check was cleared greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractContact_AmlClearedOn" type="string">
  Filter by the date when the AML check was cleared less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ContractContact_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractContact_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ContractContact_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractContact_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts?page=1&size=15&orderBy=FullName&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'FullName',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'FullName',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by FullName

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts?ContractContact_FullName=example-value&orderBy=FullName&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts?' + new URLSearchParams({
      ContractContact_FullName: 'example-value',
      orderBy: 'FullName',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      params={
          'ContractContact_FullName': 'example-value',
          'orderBy': 'FullName',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts?from_ContractContact_UpdatedOn=2025-01-01T00:00&to_ContractContact_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts?' + new URLSearchParams({
      from_ContractContact_UpdatedOn: '2025-01-01T00:00',
      to_ContractContact_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      params={
          'from_ContractContact_UpdatedOn': '2025-01-01T00:00',
          'to_ContractContact_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ContractContact[]">
  The list of ContractContact records matching the query. See the [Get one ContractContact](/rest-api/billing/get-contractcontacts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractContact. The following fields are **not populated** in the `Records[]` response: `Address`, `PostCode`, `CityName`, `State`, `Notes`, `AmlOpenSanctionsResponse`, `AmlPappersResponse`.

  To get all fields, fetch the full record using the [Get one ContractContact](/rest-api/billing/get-contractcontacts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerId": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "CoworkerEmail": null,
      "CoworkerActive": null,
      "Email": null,
      "FullName": "",
      "DateOfBirth": null,
      "CountryId": null,
      "CountryName": null,
      "PhoneNumber": null,
      "ContractContactType": 0,
      "AmlCheckStatus": 0,
      "AmlCheckDate": null,
      "AmlOpenSanctionsScore": null,
      "AmlPappersStatus": null,
      "AmlNotes": null,
      "AmlClearedBy": null,
      "AmlClearedOn": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "ContractContact Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "FullName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```