Coworkers
Search Coworkers
Search and list Coworker records with filtering, sorting, and pagination.
GET
Search Coworkers
A customer is a person or company that uses a location; members have an active contract and contacts do not.
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 Coworker-List role.Enums
eCoworkerRecordType — CoworkerType values
eCoworkerRecordType — CoworkerType values
eGender — Gender values
eGender — Gender values
eCoworkerTaxRateType — TaxRateType values
eCoworkerTaxRateType — TaxRateType values
eCoworkerAttendance — MondayAttendance values
eCoworkerAttendance — MondayAttendance values
eRegularPaymentProvider
eRegularPaymentProvider
Query Parameters
Pagination & Sorting
Filters
Filter by optional preferred form of address, such as ‘Dr Adrian’; include how the customer wants to be addressed and never use a title alone, limited to 254 characters..
Filter by customer email address; required by entity validation and used when creating an associated user account..
Filter by whether to create the associated user account when this customer is first created; create-only..
Filter by current file name of the avatar (read-only; upload via the corresponding URL field).
Filter by current file name of the banner image (read-only; upload via the corresponding URL field).
Filter by iD of the customer’s contact country; global reference data and required by entity validation..
Filter by iD of the customer’s time zone; global reference data and required by entity validation..
Filter by iD of the location that owns this customer (their home location) and issues their invoices unless invoice split by location is enabled; defaults to the current location when omitted on create..
Filter by legal or trading name printed on invoices; when empty, invoices use the company name for Company customers or FullName otherwise..
Filter by iD of the country for invoice addresses; global reference data, with the contact country and then the location country used as fallbacks..
Filter by bank name used for this customer’s regular-payment arrangement, limited to 255 characters..
Filter by customer bank account identifier for a regular-payment arrangement; do not expose or set it through the agent..
Filter by customer bank branch or sort code for a regular-payment arrangement; do not expose or set it through the agent..
Filter by external GoCardless mandate or contract identifier; managed by the payment integration and not exposed to the agent..
Filter by stripe BACS payment-method identifier; managed by the payment integration and not exposed to the agent..
Filter by stripe BACS mandate identifier; managed by the payment integration and not exposed to the agent..
Filter by stripe BACS customer token; security-sensitive integration credential not exposed to the agent..
Filter by timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent..
Filter by timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent..
Filter by regular-payment provider selected for this customer; set by the supported payment flow rather than by manual provider assignment..
Filter by external regular-payment contract or mandate identifier managed by the payment provider..
Filter by read-only last four digits of the customer’s payment card; supplied by the payment provider and not exposed to the agent..
Filter by read-only number of check-ins since the last allowance renewal; maintained from check-in activity..
Filter by read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity..
Filter by physical access-card identifier; managed through access control and not exposed to the agent..
Filter by physical access key-fob identifier; managed through access control and not exposed to the agent..
Filter by iD of the optional user account linked to this customer; update-only because creating the account uses CreateUser..
Filter by next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing..
Filter by timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent..
Filter by timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent..
Filter by localized invoice schedule value derived by the application; not exposed to the agent..
Filter by localized next automatic-invoice value derived by the application; not exposed to the agent..
Filter by localized registration-date value derived by the application; not exposed to the agent..
Filter by microsoft 365 OAuth access token; security-sensitive credential not exposed to the agent..
Filter by microsoft 365 OAuth refresh token; security-sensitive credential not exposed to the agent..
Filter by doordeck public key used by the access integration; not exposed through customer administration..
Filter by salto access-control token; security-sensitive credential not exposed to the agent..
Filter by stripe ACH bank token; security-sensitive payment credential not exposed to the agent..
Filter by stripe ACH customer token; security-sensitive payment credential not exposed to the agent..
Filter by internal Stripe ACH agreement status; maintained by the payment flow and not exposed to the agent..
Filter by internal Stripe ACH deposit-verification status; maintained by the payment flow and not exposed to the agent..
Filter by internal Square synchronization flag; maintained by the integration and not exposed to the agent..
Filter by internal marker that an access-control error notification was sent; not exposed to the agent..
Filter by read-only comma-separated list of all contract IDs for this customer; derived from contracts and not exposed to the agent..
Filter by read-only comma-separated list of plan names for all customer contracts; derived from contracts and not exposed to the agent..
Filter by read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead..
Filter by read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead..
Filter by read-only monthly billing interval of this customer’s main contract; change the contract instead..
Filter by read-only weekly billing interval of this customer’s main contract; change the contract instead..
Filter by read-only next invoice date of this customer’s main contract; change the contract instead..
Filter by read-only billing team name, populated only when the customer belongs to a merged-billing team with a paying member assigned..
Filter by read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned..
Filter by obsolete access signature derived by the access-control system; not exposed to the agent..
Filter by internal access signatures derived by the access-control system; not exposed to the agent..
Filter by whether customer-specific invoice-segregation settings override the location-level settings..
Filter by whether charges for contracts other than the main contract are invoiced separately from main-contract charges when invoice segregation is enabled..
Filter by whether booking charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Filter by whether product charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Filter by whether pass charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Filter by whether event-ticket charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Filter by whether this is the active customer profile when the linked user account has multiple customer profiles..
Filter by whether one-off charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Filter by read-only predicted probability that this customer will churn, calculated by the analytics process..
Range Filters
Filter by optional customer date of birth. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by optional customer date of birth. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by optional non-negative tax percentage override for this customer. greater than or equal to this value.
Filter by optional non-negative tax percentage override for this customer. less than or equal to this value.
Filter by timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by read-only number of check-ins since the last allowance renewal; maintained from check-in activity. greater than or equal to this value.
Filter by read-only number of check-ins since the last allowance renewal; maintained from check-in activity. less than or equal to this value.
Filter by read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity. greater than or equal to this value.
Filter by read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity. less than or equal to this value.
Filter by display value for User.LastAccess. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by display value for User.LastAccess. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by optional number of days after issue date before this customer’s invoices are due. greater than or equal to this value.
Filter by optional number of days after issue date before this customer’s invoices are due. less than or equal to this value.
Filter by optional customer registration date. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by optional customer registration date. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by localized invoice schedule value derived by the application; not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by localized invoice schedule value derived by the application; not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by localized next automatic-invoice value derived by the application; not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by localized next automatic-invoice value derived by the application; not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by localized registration-date value derived by the application; not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by localized registration-date value derived by the application; not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by internal access-control debounce timestamp; not exposed to the agent. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by internal access-control debounce timestamp; not exposed to the agent. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead. greater than or equal to this value.
Filter by read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead. less than or equal to this value.
Filter by read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead. greater than or equal to this value.
Filter by read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead. less than or equal to this value.
Filter by read-only monthly billing interval of this customer’s main contract; change the contract instead. greater than or equal to this value.
Filter by read-only monthly billing interval of this customer’s main contract; change the contract instead. less than or equal to this value.
Filter by read-only weekly billing interval of this customer’s main contract; change the contract instead. greater than or equal to this value.
Filter by read-only weekly billing interval of this customer’s main contract; change the contract instead. less than or equal to this value.
Filter by read-only next invoice date of this customer’s main contract; change the contract instead. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by read-only next invoice date of this customer’s main contract; change the contract instead. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned. greater than or equal to this value.
Filter by read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned. less than or equal to this value.
Filter by external Brivo access-control user ID managed by the integration. greater than or equal to this value.
Filter by external Brivo access-control user ID managed by the integration. less than or equal to this value.
Filter by read-only predicted probability that this customer will churn, calculated by the analytics process. greater than or equal to this value.
Filter by read-only predicted probability that this customer will churn, calculated by the analytics process. less than or equal to this value.
Filter by day of the month used to calculate the customer-specific invoice due date. greater than or equal to this value.
Filter by day of the month used to calculate the customer-specific invoice due date. less than or equal to this value.
Filter by optional geographic longitude for the contact address. greater than or equal to this value.
Filter by optional geographic longitude for the contact address. less than or equal to this value.
Filter by optional geographic latitude for the contact address. greater than or equal to this value.
Filter by optional geographic latitude for the contact address. less than or equal to this value.
Filter by optional geographic longitude for the billing address. greater than or equal to this value.
Filter by optional geographic longitude for the billing address. less than or equal to this value.
Filter by optional geographic latitude for the billing address. greater than or equal to this value.
Filter by optional geographic latitude for the billing address. less than or equal to this value.
Code Examples
Simple listing
Filtering by FullName
Range filters
Response
200
The list of Coworker records matching the query. See the Get one Coworker endpoint for the full list of properties returned for each record.
Example Response