> ## 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. # Get one CoworkerContract > Retrieve a single CoworkerContract record by its Id. A contract is a customer's plan agreement at a location. An active contract categorizes the customer as a Member; without one, they are a Contact. Its plan controls billing and can determine access, pricing, and eligibility for location services and inventory. ## 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-Read`** role. ## Path Parameters The Id of the CoworkerContract record to retrieve. ## Code Examples ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/coworkercontracts/87654321" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/billing/coworkercontracts/87654321', { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const record = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/billing/coworkercontracts/87654321', headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) record = response.json() ``` ## Response ### 200 ID of the location that issued this contract; it is supplied from the agent's current location context.. Display value for IssuedBy.Name.. ID of the customer this contract belongs to; a customer with an active contract is a Member, while one without an active contract is a Contact.. Display value for Coworker.CoworkerType.. Display value for Coworker.FullName.. Display value for Coworker.CompanyName.. Display value for Coworker.BillingName.. Display value for Coworker.Email.. Display value for Coworker.Active.. ID of the plan assigned to this contract; its billing interval, price override rules, policies, and plan-based access or eligibility govern the customer.. Display value for Tariff.Name.. Display value for Tariff.InvoiceEvery.. Display value for Tariff.InvoiceEveryWeeks.. Display value for Tariff.Price.. Display value for Tariff.Currency.Code.. Display value for Tariff.IsVirtualOffice.. ID of the plan scheduled to replace the current plan at a future renewal; leave empty when no change is scheduled.. Display value for NextTariff.Name.. Free-text internal notes about this customer contract.. Date when the contract begins; it is used to calculate billing and any minimum contract term.. Day of each month to bill this contract, from 1 through 28; scheduled monthly price changes must use this day.. System-calculated UTC date of the next plan invoice, derived from the plan, billing day, and cancellation settings.. System-maintained UTC cutoff for the most recently invoiced contract period; do not set it manually.. System-calculated UTC end of the minimum contract term; change the plan or start date instead.. Optional per-unit price override for this contract; when empty, the assigned plan's price is used before applying quantity.. Optional per-unit contract value used for value calculations; when empty, the effective contract price is used.. List of IDs of floor-plan units assigned to this contract; each unit must belong to a location the user can access.. List of IDs of floor-plan unit variants assigned to this contract; each variant's unit must belong to a location the user can access and connected to any of the desks/units associated with the contract.. Number of plan units on the contract, at least 1; it multiplies price, included time, and contract value.. Whether the contract is currently active; this is system-managed status and cannot be changed directly.. Whether this is the customer's main contract; use the dedicated set-main-contract action to change it.. Whether the contract has been cancelled; use the dedicated cancellation action rather than changing this status.. Customer purchase-order reference for this contract.. Whether the next eligible invoice includes the plan's sign-up fee.. Whether invoices include charges from future billing cycles when the plan permits them.. Whether the contract's initial charges are prorated for a partial billing period.. System-calculated UTC date when automatic additional-charge invoicing next runs; it follows the plan's auto-invoice settings.. Whether the customer accepted the assigned plan's terms and conditions.. Timestamp recorded when the customer accepted the plan terms; it is an audit value and cannot be changed directly.. Optional UTC date on which the contract ends; cancellation policy and invoicing determine the earliest allowed date.. Optional minimum cancellation notice in days before the next billing day; when empty, the assigned plan's cancellation notice applies.. Whether the cancellation invoice is prorated for the unused part of the billing period.. Whether cancelling this contract also cancels the customer's related team contracts.. Reason recorded for cancellation: PriceTooHigh, NewJobRelocation, MovedToOtherSpace, ChangeWorkEnvironment, LackCommunityInterations, PoorSpaceCondition, OtherMembers, Rellocated, BusinessExpansion, Pause, Renewed, Upgraded, Downgraded, Covid19, or Other.. Free-text notes explaining the cancellation.. Preferred handling for delivered checks: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. Preferred handling for delivered mail: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. Preferred handling for delivered parcels: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. Preferred handling for delivered publicity: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. Free-text instructions for handling deliveries received for this contract.. Optional UTC date when identity verification is due for this contract.. Optional UTC date when address verification is due for this contract.. Location-timezone projection of StartDate, generated for display and reporting; change StartDate instead.. Location-timezone projection of the system-calculated RenewalDate; do not set it directly.. Location-timezone projection of the system-calculated NextAutoInvoice date; do not set it directly.. Location-timezone projection of the plan-terms acceptance timestamp; it is an audit value.. Location-timezone projection of CancellationDate, generated for display; change CancellationDate instead.. Location-timezone projection of the system-calculated ContractTerm; do not set it directly.. Integration-managed identifier of the source proposal; it is read-only and cannot be changed through contract administration.. Integration-managed identifier of the related proposal contract; it is read-only and cannot be changed through contract administration.. Integration-managed identifier of the related course member; it is read-only and cannot be changed through contract administration.. Location-timezone projection of the system-maintained InvoicedPeriod cutoff; do not set it directly.. Read-only denormalized IDs of assigned floor-plan units; update Desks rather than this projection.. Read-only denormalized names of assigned floor-plan units; update Desks rather than this projection.. Read-only denormalized IDs of assigned floor-plan unit variants; update Variants rather than this projection.. Read-only denormalized names of assigned floor-plan unit variants; update Variants rather than this projection.. System-calculated total including the contract price, products, deposits, and quantity; update the contributing records instead.. System-calculated total including the contract price, products, and quantity; update the contributing records instead.. Post-office box number associated with this contract.. Whether the contract is currently within a recorded pause period; it is calculated from pause-period records.. Calculated UTC start of the active or upcoming pause period; manage pause records instead.. Calculated UTC end of the active or upcoming pause period; manage pause records instead.. Unique record identifier. UUID of the record. Date and time the record was created (ISO 8601). Date and time the record was last updated (ISO 8601). Email of the user who last updated this record. Whether the record was recently created. External system identifier. ```json Example Response theme={null} { "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": null, "TariffCurrencyCode": null, "TariffIsVirtualOffice": null, "NextTariffId": null, "NextTariffName": null, "Notes": 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, "PurchaseOrder": null, "IncludeSignupFee": false, "InvoiceAdvancedCycles": false, "ApplyProRating": false, "NextAutoInvoice": null, "PricePlanTermsAccepted": false, "PricePlanTermsAcceptedOn": null, "CancellationDate": null, "CancellationLimitDays": null, "ProRateCancellation": false, "CancelTeamContracts": false, "CancellationReason": 0, "CancellationNotes": null, "DeliveryHandlingPreferenceChecks": 0, "DeliveryHandlingPreferenceMail": 0, "DeliveryHandlingPreferenceParcels": 0, "DeliveryHandlingPreferencePublicity": 0, "DeliveryInstructions": null, "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, "PoBoxNumber": null, "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 } ```