CoworkerContracts
Search CoworkerContracts
Search and list CoworkerContract records with filtering, sorting, and pagination.
GET
Search CoworkerContracts
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-List role.Enums
eCancellationReason
eCancellationReason
eDeliveryHandlingPreference
eDeliveryHandlingPreference
Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the location that issued this contract; it is supplied from the agent’s current location context..
string
Filter by display value for IssuedBy.Name..
integer
Filter by 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..
string
Filter by display value for Coworker.CoworkerType..
string
Filter by display value for Coworker.FullName..
string
Filter by display value for Coworker.CompanyName..
string
Filter by display value for Coworker.BillingName..
string
Filter by display value for Coworker.Email..
boolean
Filter by display value for Coworker.Active..
integer
Filter by iD of the plan assigned to this contract; its billing interval, price override rules, policies, and plan-based access or eligibility govern the customer..
string
Filter by display value for Tariff.Name..
integer
Filter by display value for Tariff.InvoiceEvery..
integer
Filter by display value for Tariff.InvoiceEveryWeeks..
number
Filter by display value for Tariff.Price..
string
Filter by display value for Tariff.Currency.Code..
boolean
Filter by display value for Tariff.IsVirtualOffice..
integer
Filter by iD of the plan scheduled to replace the current plan at a future renewal; leave empty when no change is scheduled..
string
Filter by display value for NextTariff.Name..
string
Filter by free-text internal notes about this customer contract..
string
Filter by date when the contract begins; it is used to calculate billing and any minimum contract term..
integer
Filter by day of each month to bill this contract, from 1 through 28; scheduled monthly price changes must use this day..
string
Filter by system-calculated UTC date of the next plan invoice, derived from the plan, billing day, and cancellation settings..
string
Filter by system-maintained UTC cutoff for the most recently invoiced contract period; do not set it manually..
string
Filter by system-calculated UTC end of the minimum contract term; change the plan or start date instead..
number
Filter by optional per-unit price override for this contract; when empty, the assigned plan’s price is used before applying quantity..
number
Filter by optional per-unit contract value used for value calculations; when empty, the effective contract price is used..
integer
Filter by number of plan units on the contract, at least 1; it multiplies price, included time, and contract value..
boolean
Filter by whether the contract is currently active; this is system-managed status and cannot be changed directly..
boolean
Filter by whether this is the customer’s main contract; use the dedicated set-main-contract action to change it..
boolean
Filter by whether the contract has been cancelled; use the dedicated cancellation action rather than changing this status..
string
Filter by customer purchase-order reference for this contract..
boolean
Filter by whether the next eligible invoice includes the plan’s sign-up fee..
boolean
Filter by whether invoices include charges from future billing cycles when the plan permits them..
boolean
Filter by whether the contract’s initial charges are prorated for a partial billing period..
string
Filter by system-calculated UTC date when automatic additional-charge invoicing next runs; it follows the plan’s auto-invoice settings..
boolean
Filter by whether the customer accepted the assigned plan’s terms and conditions..
string
Filter by timestamp recorded when the customer accepted the plan terms; it is an audit value and cannot be changed directly..
string
Filter by optional UTC date on which the contract ends; cancellation policy and invoicing determine the earliest allowed date..
integer
Filter by optional minimum cancellation notice in days before the next billing day; when empty, the assigned plan’s cancellation notice applies..
boolean
Filter by whether the cancellation invoice is prorated for the unused part of the billing period..
boolean
Filter by whether cancelling this contract also cancels the customer’s related team contracts..
integer
Filter by reason recorded for cancellation: PriceTooHigh, NewJobRelocation, MovedToOtherSpace, ChangeWorkEnvironment, LackCommunityInterations, PoorSpaceCondition, OtherMembers, Rellocated, BusinessExpansion, Pause, Renewed, Upgraded, Downgraded, Covid19, or Other..
string
Filter by free-text notes explaining the cancellation..
integer
Filter by preferred handling for delivered checks: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..
integer
Filter by preferred handling for delivered mail: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..
integer
Filter by preferred handling for delivered parcels: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..
integer
Filter by preferred handling for delivered publicity: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..
string
Filter by free-text instructions for handling deliveries received for this contract..
string
Filter by optional UTC date when identity verification is due for this contract..
string
Filter by optional UTC date when address verification is due for this contract..
string
Filter by location-timezone projection of StartDate, generated for display and reporting; change StartDate instead..
string
Filter by location-timezone projection of the system-calculated RenewalDate; do not set it directly..
string
Filter by location-timezone projection of the system-calculated NextAutoInvoice date; do not set it directly..
string
Filter by location-timezone projection of the plan-terms acceptance timestamp; it is an audit value..
string
Filter by location-timezone projection of CancellationDate, generated for display; change CancellationDate instead..
string
Filter by location-timezone projection of the system-calculated ContractTerm; do not set it directly..
string
Filter by integration-managed identifier of the source proposal; it is read-only and cannot be changed through contract administration..
string
Filter by integration-managed identifier of the related proposal contract; it is read-only and cannot be changed through contract administration..
string
Filter by integration-managed identifier of the related course member; it is read-only and cannot be changed through contract administration..
string
Filter by location-timezone projection of the system-maintained InvoicedPeriod cutoff; do not set it directly..
string
Filter by read-only denormalized IDs of assigned floor-plan units; update Desks rather than this projection..
string
Filter by read-only denormalized names of assigned floor-plan units; update Desks rather than this projection..
string
Filter by read-only denormalized IDs of assigned floor-plan unit variants; update Variants rather than this projection..
string
Filter by read-only denormalized names of assigned floor-plan unit variants; update Variants rather than this projection..
number
Filter by system-calculated total including the contract price, products, deposits, and quantity; update the contributing records instead..
number
Filter by system-calculated total including the contract price, products, and quantity; update the contributing records instead..
string
Filter by post-office box number associated with this contract..
boolean
Filter by whether the contract is currently within a recorded pause period; it is calculated from pause-period records..
string
Filter by calculated UTC start of the active or upcoming pause period; manage pause records instead..
string
Filter by calculated UTC end of the active or upcoming pause period; manage pause records instead..
Range Filters
integer
Filter by display value for Tariff.InvoiceEvery. greater than or equal to this value.
integer
Filter by display value for Tariff.InvoiceEvery. less than or equal to this value.
integer
Filter by display value for Tariff.InvoiceEveryWeeks. greater than or equal to this value.
integer
Filter by display value for Tariff.InvoiceEveryWeeks. less than or equal to this value.
number
Filter by display value for Tariff.Price. greater than or equal to this value.
number
Filter by display value for Tariff.Price. less than or equal to this value.
string
Filter by date when the contract begins; it is used to calculate billing and any minimum contract term. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date when the contract begins; it is used to calculate billing and any minimum contract term. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by day of each month to bill this contract, from 1 through 28; scheduled monthly price changes must use this day. greater than or equal to this value.
integer
Filter by day of each month to bill this contract, from 1 through 28; scheduled monthly price changes must use this day. less than or equal to this value.
string
Filter by system-calculated UTC date of the next plan invoice, derived from the plan, billing day, and cancellation settings. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by system-calculated UTC date of the next plan invoice, derived from the plan, billing day, and cancellation settings. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by system-maintained UTC cutoff for the most recently invoiced contract period; do not set it manually. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by system-maintained UTC cutoff for the most recently invoiced contract period; do not set it manually. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by system-calculated UTC end of the minimum contract term; change the plan or start date instead. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by system-calculated UTC end of the minimum contract term; change the plan or start date instead. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.number
Filter by optional per-unit price override for this contract; when empty, the assigned plan’s price is used before applying quantity. greater than or equal to this value.
number
Filter by optional per-unit price override for this contract; when empty, the assigned plan’s price is used before applying quantity. less than or equal to this value.
number
Filter by optional per-unit contract value used for value calculations; when empty, the effective contract price is used. greater than or equal to this value.
number
Filter by optional per-unit contract value used for value calculations; when empty, the effective contract price is used. less than or equal to this value.
integer
Filter by number of plan units on the contract, at least 1; it multiplies price, included time, and contract value. greater than or equal to this value.
integer
Filter by number of plan units on the contract, at least 1; it multiplies price, included time, and contract value. less than or equal to this value.
string
Filter by system-calculated UTC date when automatic additional-charge invoicing next runs; it follows the plan’s auto-invoice settings. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by system-calculated UTC date when automatic additional-charge invoicing next runs; it follows the plan’s auto-invoice settings. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by timestamp recorded when the customer accepted the plan terms; it is an audit value and cannot be changed directly. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by timestamp recorded when the customer accepted the plan terms; it is an audit value and cannot be changed directly. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional UTC date on which the contract ends; cancellation policy and invoicing determine the earliest allowed date. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional UTC date on which the contract ends; cancellation policy and invoicing determine the earliest allowed date. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by optional minimum cancellation notice in days before the next billing day; when empty, the assigned plan’s cancellation notice applies. greater than or equal to this value.
integer
Filter by optional minimum cancellation notice in days before the next billing day; when empty, the assigned plan’s cancellation notice applies. less than or equal to this value.
string
Filter by optional UTC date when identity verification is due for this contract. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional UTC date when identity verification is due for this contract. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional UTC date when address verification is due for this contract. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by optional UTC date when address verification is due for this contract. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of StartDate, generated for display and reporting; change StartDate instead. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of StartDate, generated for display and reporting; change StartDate instead. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-calculated RenewalDate; do not set it directly. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-calculated RenewalDate; do not set it directly. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-calculated NextAutoInvoice date; do not set it directly. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-calculated NextAutoInvoice date; do not set it directly. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the plan-terms acceptance timestamp; it is an audit value. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the plan-terms acceptance timestamp; it is an audit value. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of CancellationDate, generated for display; change CancellationDate instead. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of CancellationDate, generated for display; change CancellationDate instead. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-calculated ContractTerm; do not set it directly. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-calculated ContractTerm; do not set it directly. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-maintained InvoicedPeriod cutoff; do not set it directly. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by location-timezone projection of the system-maintained InvoicedPeriod cutoff; do not set it directly. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.number
Filter by system-calculated total including the contract price, products, deposits, and quantity; update the contributing records instead. greater than or equal to this value.
number
Filter by system-calculated total including the contract price, products, deposits, and quantity; update the contributing records instead. less than or equal to this value.
number
Filter by system-calculated total including the contract price, products, and quantity; update the contributing records instead. greater than or equal to this value.
number
Filter by system-calculated total including the contract price, products, and quantity; update the contributing records instead. less than or equal to this value.
string
Filter by calculated UTC start of the active or upcoming pause period; manage pause records instead. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by calculated UTC start of the active or upcoming pause period; manage pause records instead. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by calculated UTC end of the active or upcoming pause period; manage pause records instead. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by calculated UTC end of the active or upcoming pause period; manage pause records instead. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
CoworkerContract[]
The list of CoworkerContract records matching the query. See the Get one CoworkerContract endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response