Skip to main content
GET
/
api
/
billing
/
coworkerdiscountcodes
/
{id}
{
  "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>"
}

​
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

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

​
Response

​
200

​
CoworkerId
integer
Coworker Id.
​
CoworkerCoworkerType
string
Coworker Coworker Type.
​
CoworkerFullName
string
Coworker Full Name.
​
CoworkerBillingName
string
Coworker Billing Name.
​
CoworkerCompanyName
string
Coworker Company Name.
​
BusinessId
integer
Business Id.
​
BusinessName
string
Business Name.
​
DiscountCodeId
integer
Discount Code Id.
​
DiscountCodeCode
string
Discount Code Code.
​
DiscountCodeActive
boolean
Discount Code Active.
​
DiscountCodeValidFrom
string
Discount Code Valid From.
​
DiscountCodeValidTo
string
Discount Code Valid To.
​
Notes
string
Notes.
​
TimesUsed
integer
Times Used.
​
ValidFrom
string
Valid From.
​
ExpiresOn
string
Expires On.
​
RefererGuid
string
Referer Guid.
​
BookingUniqueId
string
Booking Unique Id.
​
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
{
  "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
}