Get one CoworkerDiscountCode

GET

api

billing

coworkerdiscountcodes

{id}

Get one CoworkerDiscountCode

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/{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/coworkerdiscountcodes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "DiscountCodeId": 123,
  "DiscountCodeCode": "<string>",
  "DiscountCodeActive": true,
  "DiscountCodeValidFrom": "<string>",
  "DiscountCodeValidTo": "<string>",
  "Notes": "<string>",
  "TimesUsed": 123,
  "ValidFrom": "<string>",
  "ExpiresOn": "<string>",
  "RefererGuid": "<string>",
  "BookingUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CoworkerDiscountCode assigns a DiscountCode to a specific customer, allowing the system to track per-customer redemption history and enforce individual validity windows. Use ValidFrom and ExpiresOn to set customer-specific validity dates. These are distinct from the discount code’s own ValidFrom/ValidTo and ExpirationType/ExpiresIn fields — the system enforces whichever constraint is more restrictive. When the discount is part of the referral programme, RefererGuid identifies the referring customer. BookingUniqueId links the assignment to the specific booking where the code was originally applied.

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

Path Parameters

integer

required

The Id of the CoworkerDiscountCode record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer this discount code is assigned to.

string

Whether the customer is an individual or a company.

string

Full name of the customer this discount code is assigned to.

string

Billing name of the customer.

string

Company name of the customer.

integer

ID of the location this assignment belongs to.

string

Name of the location this assignment belongs to.

integer

ID of the discount code assigned to this customer.

string

The alphanumeric code customers enter to apply the discount.

boolean

Whether the discount code is currently active and can be redeemed.

string

Start date from which the discount code itself can be redeemed (set on the discount code).

string

End date after which the discount code itself can no longer be redeemed (set on the discount code).

string

Optional notes about this discount code assignment.

integer

Number of times this customer has redeemed the discount code.

string

Customer-specific date from which this discount code assignment becomes valid.

string

Customer-specific date after which this discount code assignment expires.

string

Unique identifier of the customer who referred this customer, when the discount is part of the referral programme.

string

Unique identifier of the booking to which this discount code was applied.

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

{
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerBillingName": null,
  "CoworkerCompanyName": null,
  "BusinessId": 0,
  "BusinessName": null,
  "DiscountCodeId": 0,
  "DiscountCodeCode": null,
  "DiscountCodeActive": null,
  "DiscountCodeValidFrom": null,
  "DiscountCodeValidTo": null,
  "Notes": null,
  "TimesUsed": 0,
  "ValidFrom": null,
  "ExpiresOn": null,
  "RefererGuid": null,
  "BookingUniqueId": 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": "CoworkerDiscountCode Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerDiscountCodesRetrieve multiple CoworkerDiscountCode records by their Ids in a single request.

Get one CoworkerDiscountCode

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/{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/coworkerdiscountcodes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "DiscountCodeId": 123,
  "DiscountCodeCode": "<string>",
  "DiscountCodeActive": true,
  "DiscountCodeValidFrom": "<string>",
  "DiscountCodeValidTo": "<string>",
  "Notes": "<string>",
  "TimesUsed": 123,
  "ValidFrom": "<string>",
  "ExpiresOn": "<string>",
  "RefererGuid": "<string>",
  "BookingUniqueId": "<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