Skip to main content
GET
/
api
/
billing
/
coworkerdiscountcodes
Search CoworkerDiscountCodes
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerdiscountcodes \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
CoworkerDiscountCode_Coworker
integer
Filter by iD of the customer this discount code is assigned to.
​
CoworkerDiscountCode_Coworker_CoworkerType
string
Filter by whether the customer is an individual or a company.
​
CoworkerDiscountCode_Coworker_FullName
string
Filter by full name of the customer this discount code is assigned to.
​
CoworkerDiscountCode_Coworker_BillingName
string
Filter by billing name of the customer.
​
CoworkerDiscountCode_Coworker_CompanyName
string
Filter by company name of the customer.
​
CoworkerDiscountCode_Business
integer
Filter by iD of the location this assignment belongs to.
​
CoworkerDiscountCode_Business_Name
string
Filter by name of the location this assignment belongs to.
​
CoworkerDiscountCode_DiscountCode
integer
Filter by iD of the discount code assigned to this customer.
​
CoworkerDiscountCode_DiscountCode_Code
string
Filter by the alphanumeric code customers enter to apply the discount.
​
CoworkerDiscountCode_DiscountCode_Active
boolean
Filter by whether the discount code is currently active and can be redeemed.
​
CoworkerDiscountCode_DiscountCode_ValidFrom
string
Filter by start date from which the discount code itself can be redeemed (set on the discount code).
​
CoworkerDiscountCode_DiscountCode_ValidTo
string
Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code).
​
CoworkerDiscountCode_Notes
string
Filter by optional notes about this discount code assignment.
​
CoworkerDiscountCode_TimesUsed
integer
Filter by number of times this customer has redeemed the discount code.
​
CoworkerDiscountCode_ValidFrom
string
Filter by customer-specific date from which this discount code assignment becomes valid.
​
CoworkerDiscountCode_ExpiresOn
string
Filter by customer-specific date after which this discount code assignment expires.
​
CoworkerDiscountCode_RefererGuid
string
Filter by unique identifier of the customer who referred this customer, when the discount is part of the referral programme.
​
CoworkerDiscountCode_BookingUniqueId
string
Filter by unique identifier of the booking to which this discount code was applied.

​
Range Filters

​
from_CoworkerDiscountCode_DiscountCodeValidFrom
string
Filter by start date from which the discount code itself can be redeemed (set on the discount code) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_DiscountCodeValidFrom
string
Filter by start date from which the discount code itself can be redeemed (set on the discount code) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_DiscountCodeValidTo
string
Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_DiscountCodeValidTo
string
Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_TimesUsed
integer
Filter by number of times this customer has redeemed the discount code greater than or equal to this value.
​
to_CoworkerDiscountCode_TimesUsed
integer
Filter by number of times this customer has redeemed the discount code less than or equal to this value.
​
from_CoworkerDiscountCode_ValidFrom
string
Filter by customer-specific date from which this discount code assignment becomes valid greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_ValidFrom
string
Filter by customer-specific date from which this discount code assignment becomes valid less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_ExpiresOn
string
Filter by customer-specific date after which this discount code assignment expires greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_ExpiresOn
string
Filter by customer-specific date after which this discount code assignment expires less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?CoworkerDiscountCode_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?from_CoworkerDiscountCode_UpdatedOn=2025-01-01T00:00&to_CoworkerDiscountCode_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
CoworkerDiscountCode[]
The list of CoworkerDiscountCode records matching the query. See the Get one CoworkerDiscountCode endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each CoworkerDiscountCode. The following fields are not populated in the Records[] response: Notes.To get all fields, fetch the full record using the Get one CoworkerDiscountCode 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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerBillingName": null,
      "CoworkerCompanyName": null,
      "BusinessId": 0,
      "BusinessName": null,
      "DiscountCodeId": 0,
      "DiscountCodeCode": null,
      "DiscountCodeActive": null,
      "DiscountCodeValidFrom": null,
      "DiscountCodeValidTo": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}