> ## 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. # Search CoworkerProducts > Search and list CoworkerProduct records with filtering, sorting, and pagination. A **CoworkerProduct** is a record of a product sold to a customer as a one-off or on a recurrent basis. `RepeatCycle` can only be set to `PricePlan` if the customer has a contract set as their main contract. In general, it is best to use `ContractProduct` instead of adding CoworkerProducts repeating based on `PricePlan`. `InvoiceThisCoworker` indicates this customer should be invoiced for this product instead of the paying member of their team. `ActivateNow` releases any benefits (credits or passes) even before the product is invoiced and paid. `ProductApplyProRating` indicates the sold product is configured to prorate the price of this sale based on the prorating rules of the main contract of the customer: it adjusts the price based on the number of days left between the current date and the next invoice date (`RenewalDate`) of the customer's main contract. Properties ending in `UniqueId` link the sale to the originating record using its GUID `UniqueId` property (not the integer ID). Only one of these will be populated per record: | UniqueId property | Source entity | | -------------------------- | ---------------- | | `CoworkerContractUniqueId` | CoworkerContract | | `ContractDepositUniqueId` | ContractDeposit | | `ContractProductUniqueId` | ContractProduct | | `BookingUniqueId` | Booking | | `CoworkerDeliveryUniqueId` | CoworkerDelivery | ## 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 **`CoworkerProduct-List`** role. ## Enums | Value | Name | | ----- | -------------- | | 1 | PricePlan | | 2 | Day | | 3 | Week | | 4 | Month | | 5 | Year | | 6 | LastDayOfMonth | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by Coworker Id. Filter by coworker type. Filter by coworker full name. Filter by coworker company name. Filter by coworker billing name. Filter by coworker email. Filter by Business Id. Filter by Product Id. Filter by product name. Filter by product price. Filter by whether the sold product is configured to prorate the price of this sale based on the prorating rules of the customer's main contract, adjusting the price based on the number of days left until the next invoice date (RenewalDate). Filter by product currency code. Filter by notes. Filter by purchase order. Filter by order number. Filter by whether the product is activated. Filter by activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid. Filter by invoice this customer for this product instead of the paying member of their team. Filter by price override. Filter by quantity. Filter by whether this is a regular charge. Filter by repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan. Filter by number of repeat units. Filter by invoice on date. Filter by repeat from date. Filter by repeat until date. Filter by sale date. Filter by due date. Filter by whether it has been invoiced. Filter by date invoiced. Filter by whether added from tariff. Filter by links to the Booking that generated this sale (GUID UniqueId, not integer ID). Filter by Mrm Reminded. Filter by apply pro-rating. Filter by links to the CoworkerContract that generated this sale (GUID UniqueId, not integer ID). Filter by links to the ContractDeposit that generated this sale (GUID UniqueId, not integer ID). Filter by links to the ContractProduct that generated this sale (GUID UniqueId, not integer ID). Filter by links to the CoworkerDelivery that generated this sale (GUID UniqueId, not integer ID). Filter by Proposal Unique Id. Filter by coworker invoice ID. Filter by coworker invoice number. Filter by whether coworker invoice is paid. Filter by teams at the time of purchase. Filter by credit amount. Filter by discount amount. ### Range Filters Filter by product price greater than or equal to this value. Filter by product price less than or equal to this value. Filter by price override greater than or equal to this value. Filter by price override less than or equal to this value. Filter by quantity greater than or equal to this value. Filter by quantity less than or equal to this value. Filter by number of repeat units greater than or equal to this value. Filter by number of repeat units less than or equal to this value. Filter by invoice on date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoice on date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat from date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat from date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat until date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat until date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by sale date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by sale date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date invoiced greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date invoiced less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by coworker invoice ID greater than or equal to this value. Filter by coworker invoice ID less than or equal to this value. Filter by credit amount greater than or equal to this value. Filter by credit amount less than or equal to this value. Filter by discount amount greater than or equal to this value. Filter by discount amount less than or equal to this value. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/coworkerproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({ page: 1, size: 15, orderBy: 'CreatedOn', dir: 1 // Ascending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/coworkerproducts', params={ 'page': 1, 'size': 15, 'orderBy': 'CreatedOn', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Filtering by CreatedOn ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/coworkerproducts?CoworkerProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({ CoworkerProduct_CreatedOn: 'example-value', orderBy: 'CreatedOn', dir: 1 }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/coworkerproducts', params={ 'CoworkerProduct_CreatedOn': 'example-value', 'orderBy': 'CreatedOn', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Range filters ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/coworkerproducts?from_CoworkerProduct_UpdatedOn=2025-01-01T00:00&to_CoworkerProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({ from_CoworkerProduct_UpdatedOn: '2025-01-01T00:00', to_CoworkerProduct_UpdatedOn: '2025-12-31T23:59', orderBy: 'UpdatedOn', dir: 1 // Descending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/coworkerproducts', params={ 'from_CoworkerProduct_UpdatedOn': '2025-01-01T00:00', 'to_CoworkerProduct_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of CoworkerProduct records matching the query. See the [Get one CoworkerProduct](/rest-api/billing/get-coworkerproducts-by-id) endpoint for the full list of properties returned for each record. **Partial records** — The listing endpoint returns a summary representation of each CoworkerProduct. The following fields are **not populated** in the `Records[]` response: `Notes`, `PurchaseOrder`, `ActivateNow`, `InvoiceThisCoworker`, `CreditAmount`, `DiscountAmount`. To get all fields, fetch the full record using the [Get one CoworkerProduct](/rest-api/billing/get-coworkerproducts-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "Records": [ { "CoworkerId": 0, "CoworkerCoworkerType": null, "CoworkerFullName": null, "CoworkerCompanyName": null, "CoworkerBillingName": null, "CoworkerEmail": null, "BusinessId": 0, "ProductId": 0, "ProductName": null, "ProductPrice": 0, "ProductApplyProRating": null, "ProductCurrencyCode": null, "OrderNumber": null, "Activated": false, "Price": null, "Quantity": 0, "RegularCharge": false, "RepeatCycle": 0, "RepeatUnit": null, "InvoiceOn": null, "RepeatFrom": null, "RepeatUntil": null, "SaleDate": null, "DueDate": null, "Invoiced": false, "InvoicedOn": null, "FromTariff": false, "BookingUniqueId": null, "MrmReminded": false, "ApplyProRating": false, "CoworkerContractUniqueId": null, "ContractDepositUniqueId": null, "ContractProductUniqueId": null, "CoworkerDeliveryUniqueId": null, "ProposalUniqueId": null, "CoworkerInvoiceId": null, "CoworkerInvoiceNumber": null, "CoworkerInvoicePaid": false, "TeamsAtTheTimeOfPurchase": 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": "CoworkerProduct 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 } ```