Get one ContractContact

GET

api

billing

contractcontacts

{id}

Get one ContractContact

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/contractcontacts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/contractcontacts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/contractcontacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerActive": true,
  "Email": "<string>",
  "FullName": "<string>",
  "DateOfBirth": "<string>",
  "Address": "<string>",
  "PostCode": "<string>",
  "CityName": "<string>",
  "State": "<string>",
  "CountryId": 123,
  "CountryName": "<string>",
  "PhoneNumber": "<string>",
  "Notes": "<string>",
  "ContractContactType": 123,
  "AmlCheckStatus": 123,
  "AmlCheckDate": "<string>",
  "AmlOpenSanctionsScore": 123,
  "AmlOpenSanctionsResponse": "<string>",
  "AmlPappersResponse": "<string>",
  "AmlPappersStatus": "<string>",
  "AmlNotes": "<string>",
  "AmlClearedBy": "<string>",
  "AmlClearedOn": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the ContractContact record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/contractcontacts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractcontacts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/contractcontacts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the coworker contract linked to this record.

integer

The coworker contract quantity value for this contract contact.

string

The coworker contract floor plan desk ids value for this contract contact.

string

The coworker contract floor plan desk names value for this contract contact.

string

Plan name of the associated virtual office contract.

integer

ID of the coworker linked to this record.

string

Full name of the linked coworker.

string

Company name of the linked coworker.

string

Billing name of the linked coworker.

string

Email address of the linked coworker.

boolean

Whether coworker active is enabled.

string

Email address of the contact. Used when the contact is not linked to a coworker record.

string

Full name of the contact. Used when the contact is not linked to a coworker record.

string

Date of birth. Used for identity verification purposes.

string

Street address.

string

Post code.

string

City name.

string

State or province.

integer

ID of the country linked to this record.

string

Country name.

string

Phone number.

string

Optional notes or comments about this contract contact.

integer

Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company). See eContractContactType enum values: 0 = None, 1 = Director, 2 = CompanyAlias, 3 = NominatedRecipient.

integer

The AML check status for this contact. See eAmlCheckStatus enum values: 0 = NotStarted, 1 = Pending, 2 = Clear, 3 = PotentialMatch, 4 = ConfirmedMatch, 5 = Error, 6 = ManuallyCleared.

string

The date when the AML check was performed.

number

The score from the open sanctions check.

string

The response from the open sanctions check as JSON string.

string

The response from the Pappers AML check as TEXT string.

string

The status from the Pappers AML check.

string

Notes related to the AML check. Customers cannot see this field, it’s for internal use only.

string

The user who cleared the AML check.

string

The date when the AML check was cleared.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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,
  "Address": null,
  "PostCode": null,
  "CityName": null,
  "State": null,
  "CountryId": null,
  "CountryName": null,
  "PhoneNumber": null,
  "Notes": null,
  "ContractContactType": 0,
  "AmlCheckStatus": 0,
  "AmlCheckDate": null,
  "AmlOpenSanctionsScore": null,
  "AmlOpenSanctionsResponse": null,
  "AmlPappersResponse": 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
}

Get multiple ContractContactsRetrieve multiple ContractContact records by their Ids in a single request.

Get one ContractContact

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/contractcontacts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/contractcontacts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/contractcontacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerActive": true,
  "Email": "<string>",
  "FullName": "<string>",
  "DateOfBirth": "<string>",
  "Address": "<string>",
  "PostCode": "<string>",
  "CityName": "<string>",
  "State": "<string>",
  "CountryId": 123,
  "CountryName": "<string>",
  "PhoneNumber": "<string>",
  "Notes": "<string>",
  "ContractContactType": 123,
  "AmlCheckStatus": 123,
  "AmlCheckDate": "<string>",
  "AmlOpenSanctionsScore": 123,
  "AmlOpenSanctionsResponse": "<string>",
  "AmlPappersResponse": "<string>",
  "AmlPappersStatus": "<string>",
  "AmlNotes": "<string>",
  "AmlClearedBy": "<string>",
  "AmlClearedOn": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200