Skip to main content
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>'
{
  "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,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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.

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:
TypeDescription
DirectorA director of the company registered under the virtual office contract
CompanyAliasA trading name or alias used by the company
NominatedRecipientA 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

​
id
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"

​
Response

​
200

​
CoworkerContractId
integer
Coworker Contract Id.
​
CoworkerContractQuantity
integer
Coworker Contract Quantity.
​
CoworkerContractFloorPlanDeskIds
string
Coworker Contract Floor Plan Desk Ids.
​
CoworkerContractFloorPlanDeskNames
string
Coworker Contract Floor Plan Desk Names.
​
CoworkerContractTariffName
string
Plan name of the associated virtual office contract.
​
CoworkerId
integer
Coworker Id.
​
CoworkerFullName
string
Full name of the linked coworker.
​
CoworkerCompanyName
string
Company name of the linked coworker.
​
CoworkerBillingName
string
Billing name of the linked coworker.
​
CoworkerEmail
string
Email address of the linked coworker.
​
CoworkerActive
boolean
Coworker Active.
​
Email
string
Email address of the contact. Used when the contact is not linked to a coworker record.
​
FullName
string
Full name of the contact. Used when the contact is not linked to a coworker record.
​
DateOfBirth
string
Date of birth. Used for identity verification purposes.
​
Address
string
Address.
​
PostCode
string
Post code.
​
CityName
string
City name.
​
State
string
State.
​
CountryId
integer
Country Id.
​
CountryName
string
Country name.
​
PhoneNumber
string
Phone number.
​
Notes
string
Notes.
​
ContractContactType
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.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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,
  "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
}