> ## 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 CoworkerContracts > Search and list CoworkerContract records with filtering, sorting, and pagination. A **CoworkerContract** is the foundation for automatic billing. It links a customer (`Coworker`) to a plan (`Tariff`) that drives the billing frequency, benefits and default settings for the contract. A customer can hold as many contracts as needed, each pointing to the same or different plans. A customer with at least one active contract is regarded as a **Member**; customers with no active contracts are **Contacts**. Nexudus uses this distinction to enforce policies on products, resources, events, pricing and many other entities that expose `OnlyForMembers` or `OnlyForContacts` properties. **Pricing** — The contract price can be fixed (`Price` is not null) or derived from the plan it is for. The `Value` field is used in reporting to compare with the actual price. Automatic price adjustments over time can be set up via `ContractSchedule` child entities. **Billing cycle** — `RenewalDate` is the date on which the contract will next be automatically invoiced; it advances automatically each time the contract is invoiced. `InvoicedPeriod` is the period the next invoice will cover. For a new contract these two dates are usually the same. If `Tariff.AdvanceInvoiceCycles` is greater than 1, Nexudus invoices several periods in one go the first time, pushing `InvoicedPeriod` ahead of `RenewalDate` from the first invoice onwards. When the contract is cancelled, Nexudus stops invoicing once `InvoicedPeriod` reaches the cancellation date. **Benefits** — The plan may include benefits (booking credits, time passes, etc.) which are released and assigned to the contract-holder customer based on the contract cycle or other expiration criteria (month, week, day, etc.). **Cancellation** — Contracts support minimum contract length (`ContractTerm`), cancellation policies (`CancellationLimitDays`, `ProRateCancellation`) and cancellation reasons. `CancelTeamContracts` can cascade cancellation to team members. **Additional charges** — Contracts can optionally include products (`ContractProduct` entities) to be billed alongside the plan, as well as security deposits/retainers (`ContractDeposit` entities). ## 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 **`CoworkerContract-List`** role. ## Enums | Value | Name | | ----- | ------------------------ | | 1 | PriceTooHigh | | 2 | NewJobRelocation | | 3 | MovedToOtherSpace | | 4 | ChangeWorkEnvironment | | 5 | LackCommunityInterations | | 6 | PoorSpaceCondition | | 7 | OtherMembers | | 8 | Rellocated | | 9 | BusinessExpansion | | 10 | Pause | | 11 | Renewed | | 12 | Upgraded | | 13 | Downgraded | | 19 | Covid19 | | 99 | Other | | Value | Name | | ----- | -------------------------- | | 1 | StoreForCollection | | 2 | Forward | | 3 | OpenScanForward | | 4 | OpenScanRecycle | | 5 | OpenScanShred | | 6 | OpenScanStoreForCollection | | 7 | Recycle | | 8 | ReturnToSender | | 9 | Shred | | 10 | DepositCheck | | 11 | Unknown | ## 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 Issued By Id. Filter by name of the business issuing this contract. Filter by Coworker Id. Filter by Coworker Coworker Type. Filter by full name of the customer holding this contract. Filter by company name of the customer holding this contract. Filter by billing name of the customer holding this contract. Filter by email address of the customer holding this contract. Filter by Coworker Active. Filter by Tariff Id. Filter by name of the plan this contract is for. Filter by Tariff Invoice Every. Filter by Tariff Invoice Every Weeks. Filter by default price of the plan. Used when the contract has no fixed Price override. Filter by currency code of the plan. Filter by Next Tariff Id. Filter by name of the next plan the contract will switch to. Filter by free-text notes for this contract. Filter by contract start date. Filter by day of month on which billing occurs. Filter by date on which the contract will next be automatically invoiced. Updated automatically every time the contract is invoiced, advancing by the plan's renewal period. Filter by period the next invoice will cover. For new contracts this equals RenewalDate. If Tariff.AdvanceInvoiceCycles > 1, Nexudus invoices several periods at once on the first invoice, pushing InvoicedPeriod ahead of RenewalDate. Nexudus stops invoicing when InvoicedPeriod reaches the cancellation date. Filter by minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty. Filter by fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice). Filter by contract value used in reporting to compare against the actual invoiced price. Filter by quantity. Filter by whether the contract is active. Active contracts make the customer a Member; inactive contracts make them a Contact. Filter by whether this is the customer's main contract. The main contract drives the customer's primary plan assignment. Filter by whether this contract has been cancelled. Filter by purchase order. Filter by whether to include the plan's signup fee when creating this contract. Filter by whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles. Filter by whether to pro-rate the first invoice based on the contract start date relative to the billing cycle. Filter by date of the next automatic invoice generation for this contract. Filter by whether the customer has accepted the plan's terms and conditions. Filter by date on which the customer accepted the plan's terms and conditions. Filter by date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date. Filter by minimum number of days' notice required before cancellation takes effect. Filter by whether to pro-rate the final invoice when the contract is cancelled mid-cycle. Filter by whether to cascade cancellation to contracts of team members under this customer. Filter by reason for cancellation. Filter by free-text notes about the cancellation. Filter by delivery handling preference for checks. Filter by delivery handling preference for mail. Filter by delivery handling preference for parcels. Filter by delivery handling preference for publicity. Filter by free-text delivery instructions for this contract's mail handling. Filter by date by which identity verification checks must be completed for this contract. Filter by date by which address verification checks must be completed for this contract. Filter by Start Date Local. Filter by Renewal Date Local. Filter by Next Auto Invoice Local. Filter by Price Plan Terms Accepted On Local. Filter by Cancellation Date Local. Filter by Contract Term Local. Filter by unique ID of the proposal that originated this contract. Filter by unique ID of the proposal contract line that originated this contract. Filter by Course Member Unique Id. Filter by Invoiced Period Local. Filter by comma-separated IDs of floor-plan items assigned to this contract. Filter by comma-separated names of floor-plan items assigned to this contract. Filter by comma-separated IDs of floor-plan item variants assigned to this contract. Filter by comma-separated names of floor-plan item variants assigned to this contract. Filter by total contract price including linked products (CoworkerProducts) and security deposits. Filter by total contract price including linked products (CoworkerProducts) but excluding security deposits. Filter by pO box number. Filter by whether the contract is currently in a paused period. Paused contracts are not invoiced. Filter by start date of the current pause period. Filter by end date of the current pause period. The contract resumes billing after this date. ### Range Filters Filter by tariff invoice every greater than or equal to this value. Filter by tariff invoice every less than or equal to this value. Filter by tariff invoice every weeks greater than or equal to this value. Filter by tariff invoice every weeks less than or equal to this value. Filter by default price of the plan. Used when the contract has no fixed Price override greater than or equal to this value. Filter by default price of the plan. Used when the contract has no fixed Price override less than or equal to this value. Filter by contract start date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by contract start date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by day of month on which billing occurs greater than or equal to this value. Filter by day of month on which billing occurs less than or equal to this value. Filter by date on which the contract will next be automatically invoiced. Updated automatically every time the contract is invoiced, advancing by the plan's renewal period greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date on which the contract will next be automatically invoiced. Updated automatically every time the contract is invoiced, advancing by the plan's renewal period less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by period the next invoice will cover. For new contracts this equals RenewalDate. If Tariff.AdvanceInvoiceCycles > 1, Nexudus invoices several periods at once on the first invoice, pushing InvoicedPeriod ahead of RenewalDate. Nexudus stops invoicing when InvoicedPeriod reaches the cancellation date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by period the next invoice will cover. For new contracts this equals RenewalDate. If Tariff.AdvanceInvoiceCycles > 1, Nexudus invoices several periods at once on the first invoice, pushing InvoicedPeriod ahead of RenewalDate. Nexudus stops invoicing when InvoicedPeriod reaches the cancellation date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice) greater than or equal to this value. Filter by fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice) less than or equal to this value. Filter by contract value used in reporting to compare against the actual invoiced price greater than or equal to this value. Filter by contract value used in reporting to compare against the actual invoiced price 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 date of the next automatic invoice generation for this contract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date of the next automatic invoice generation for this contract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date on which the customer accepted the plan's terms and conditions greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date on which the customer accepted the plan's terms and conditions less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by minimum number of days' notice required before cancellation takes effect greater than or equal to this value. Filter by minimum number of days' notice required before cancellation takes effect less than or equal to this value. Filter by date by which identity verification checks must be completed for this contract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date by which identity verification checks must be completed for this contract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date by which address verification checks must be completed for this contract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date by which address verification checks must be completed for this contract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by start date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by start date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by renewal date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by renewal date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next auto invoice local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next auto invoice local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by price plan terms accepted on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by price plan terms accepted on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by cancellation date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by cancellation date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by contract term local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by contract term local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoiced period local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoiced period local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by total contract price including linked products (CoworkerProducts) and security deposits greater than or equal to this value. Filter by total contract price including linked products (CoworkerProducts) and security deposits less than or equal to this value. Filter by total contract price including linked products (CoworkerProducts) but excluding security deposits greater than or equal to this value. Filter by total contract price including linked products (CoworkerProducts) but excluding security deposits less than or equal to this value. Filter by start date of the current pause period greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by start date of the current pause period less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by end date of the current pause period. The contract resumes billing after this date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by end date of the current pause period. The contract resumes billing after this date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. 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/coworkercontracts?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/coworkercontracts?' + 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/coworkercontracts', 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/coworkercontracts?CoworkerContract_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/coworkercontracts?' + new URLSearchParams({ CoworkerContract_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/coworkercontracts', params={ 'CoworkerContract_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/coworkercontracts?from_CoworkerContract_UpdatedOn=2025-01-01T00:00&to_CoworkerContract_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/coworkercontracts?' + new URLSearchParams({ from_CoworkerContract_UpdatedOn: '2025-01-01T00:00', to_CoworkerContract_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/coworkercontracts', params={ 'from_CoworkerContract_UpdatedOn': '2025-01-01T00:00', 'to_CoworkerContract_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of CoworkerContract records matching the query. See the [Get one CoworkerContract](/rest-api/billing/get-coworkercontracts-by-id) endpoint for the full list of properties returned for each record. **Partial records** — The listing endpoint returns a summary representation of each CoworkerContract. The following fields are **not populated** in the `Records[]` response: `Notes`, `PurchaseOrder`, `CancellationNotes`, `DeliveryInstructions`, `PoBoxNumber`. To get all fields, fetch the full record using the [Get one CoworkerContract](/rest-api/billing/get-coworkercontracts-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": [ { "IssuedById": 0, "IssuedByName": null, "CoworkerId": 0, "CoworkerCoworkerType": null, "CoworkerFullName": null, "CoworkerCompanyName": null, "CoworkerBillingName": null, "CoworkerEmail": null, "CoworkerActive": null, "TariffId": 0, "TariffName": null, "TariffInvoiceEvery": null, "TariffInvoiceEveryWeeks": null, "TariffPrice": 0, "TariffCurrencyCode": null, "NextTariffId": null, "NextTariffName": null, "StartDate": null, "BillingDay": 0, "RenewalDate": null, "InvoicedPeriod": null, "ContractTerm": null, "Price": null, "Value": null, "Desks": [], "Variants": [], "Quantity": 0, "Active": false, "MainContract": false, "Cancelled": false, "IncludeSignupFee": false, "InvoiceAdvancedCycles": false, "ApplyProRating": false, "NextAutoInvoice": null, "PricePlanTermsAccepted": false, "PricePlanTermsAcceptedOn": null, "CancellationDate": null, "CancellationLimitDays": null, "ProRateCancellation": false, "CancelTeamContracts": false, "CancellationReason": 0, "DeliveryHandlingPreferenceChecks": 0, "DeliveryHandlingPreferenceMail": 0, "DeliveryHandlingPreferenceParcels": 0, "DeliveryHandlingPreferencePublicity": 0, "IdentityChecksDueOn": null, "AddressChecksDueOn": null, "StartDateLocal": null, "RenewalDateLocal": null, "NextAutoInvoiceLocal": null, "PricePlanTermsAcceptedOnLocal": null, "CancellationDateLocal": null, "ContractTermLocal": null, "ProposalUniqueId": null, "ProposalContractUniqueId": null, "CourseMemberUniqueId": null, "InvoicedPeriodLocal": null, "FloorPlanDeskIds": null, "FloorPlanDeskNames": null, "FloorPlanDeskVariantIds": null, "FloorPlanDeskVariantNames": null, "PriceWithProductsAndDeposits": 0, "PriceWithProducts": 0, "InPausedPeriod": false, "InPausedPeriodFrom": null, "InPausedPeriodUntil": 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": "CoworkerContract 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 } ```