Skip to main content
GET
/
api
/
billing
/
coworkerdiscountcodes
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​
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 Coworker Id.
​
CoworkerDiscountCode_Coworker_CoworkerType
string
Filter by Coworker Coworker Type.
​
CoworkerDiscountCode_Coworker_FullName
string
Filter by Coworker Full Name.
​
CoworkerDiscountCode_Coworker_BillingName
string
Filter by Coworker Billing Name.
​
CoworkerDiscountCode_Coworker_CompanyName
string
Filter by Coworker Company Name.
​
CoworkerDiscountCode_Business
integer
Filter by Business Id.
​
CoworkerDiscountCode_Business_Name
string
Filter by Business Name.
​
CoworkerDiscountCode_DiscountCode
integer
Filter by Discount Code Id.
​
CoworkerDiscountCode_DiscountCode_Code
string
Filter by Discount Code Code.
​
CoworkerDiscountCode_DiscountCode_Active
boolean
Filter by Discount Code Active.
​
CoworkerDiscountCode_DiscountCode_ValidFrom
string
Filter by Discount Code Valid From.
​
CoworkerDiscountCode_DiscountCode_ValidTo
string
Filter by Discount Code Valid To.
​
CoworkerDiscountCode_Notes
string
Filter by Notes.
​
CoworkerDiscountCode_TimesUsed
integer
Filter by Times Used.
​
CoworkerDiscountCode_ValidFrom
string
Filter by Valid From.
​
CoworkerDiscountCode_ExpiresOn
string
Filter by Expires On.
​
CoworkerDiscountCode_RefererGuid
string
Filter by Referer Guid.
​
CoworkerDiscountCode_BookingUniqueId
string
Filter by Booking Unique Id.

​
Range Filters

​
from_CoworkerDiscountCode_DiscountCodeValidFrom
string
Filter by discount code valid from greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_DiscountCodeValidFrom
string
Filter by discount code valid from less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_DiscountCodeValidTo
string
Filter by discount code valid to greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_DiscountCodeValidTo
string
Filter by discount code valid to less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_TimesUsed
integer
Filter by times used greater than or equal to this value.
​
to_CoworkerDiscountCode_TimesUsed
integer
Filter by times used less than or equal to this value.
​
from_CoworkerDiscountCode_ValidFrom
string
Filter by valid from greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_ValidFrom
string
Filter by valid from less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerDiscountCode_ExpiresOn
string
Filter by expires on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerDiscountCode_ExpiresOn
string
Filter by expires on 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 included 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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}