Coworkers
Get one Coworker
Retrieve a single Coworker record by its Id.
GET
Get one Coworker
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-Read role.Path Parameters
Code Examples
Response
200
Whether this customer record represents an Individual or a Company.. See
eCoworkerRecordType enum values: 1 = Individual, 2 = Company.List of location IDs where this customer is registered; replacing the list replaces all registrations..
List of team IDs this customer belongs to; replacing the list replaces all team memberships..
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..
Optional customer gender: NotSet, Male, Female, Other, or RatherNotSay.. See
eGender enum values: 1 = NotSet, 2 = Male, 3 = Female, 4 = Other, 5 = RatherNotSay.Customer email address; required by entity validation and used when creating an associated user account..
Whether to create the associated user account when this customer is first created; create-only..
ID of the customer’s contact country; global reference data and required by entity validation..
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..
Legal or trading name printed on invoices; when empty, invoices use the company name for Company customers or FullName otherwise..
ID of the country for invoice addresses; global reference data, with the contact country and then the location country used as fallbacks..
Tax treatment for this customer: Default, Reduced, or Exempt.. See
eCoworkerTaxRateType enum values: 1 = Default, 2 = Reduced, 3 = Exempt.Customer bank account identifier for a regular-payment arrangement; do not expose or set it through the agent..
Customer bank branch or sort code for a regular-payment arrangement; do not expose or set it through the agent..
External GoCardless mandate or contract identifier; managed by the payment integration and not exposed to the agent..
Stripe BACS payment-method identifier; managed by the payment integration and not exposed to the agent..
Stripe BACS mandate identifier; managed by the payment integration and not exposed to the agent..
Stripe BACS customer token; security-sensitive integration credential not exposed to the agent..
Timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent..
Timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent..
Regular-payment provider selected for this customer; set by the supported payment flow rather than by manual provider assignment..
Read-only last four digits of the customer’s payment card; supplied by the payment provider and not exposed to the agent..
Read-only number of check-ins since the last allowance renewal; maintained from check-in activity..
Read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity..
Physical access-card identifier; managed through access control and not exposed to the agent..
Physical access key-fob identifier; managed through access control and not exposed to the agent..
ID of the optional user account linked to this customer; update-only because creating the account uses CreateUser..
Next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing..
Timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent..
Timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent..
Doordeck public key used by the access integration; not exposed through customer administration..
Internal Stripe ACH agreement status; maintained by the payment flow and not exposed to the agent..
Internal Stripe ACH deposit-verification status; maintained by the payment flow and not exposed to the agent..
Internal Square synchronization flag; maintained by the integration and not exposed to the agent..
Internal marker that an access-control error notification was sent; not exposed to the agent..
Read-only comma-separated list of all contract IDs for this customer; derived from contracts and not exposed to the agent..
Read-only comma-separated list of plan names for all customer contracts; derived from contracts and not exposed to the agent..
Read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead..
Read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead..
Read-only monthly billing interval of this customer’s main contract; change the contract instead..
Read-only weekly billing interval of this customer’s main contract; change the contract instead..
Read-only billing team name, populated only when the customer belongs to a merged-billing team with a paying member assigned..
Read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned..
Whether customer-specific invoice-segregation settings override the location-level settings..
Whether charges for contracts other than the main contract are invoiced separately from main-contract charges when invoice segregation is enabled..
Whether booking charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether product charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether pass charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether event-ticket charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether this is the active customer profile when the linked user account has multiple customer profiles..
Whether one-off charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Read-only predicted probability that this customer will churn, calculated by the analytics process..
Expected Monday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Expected Tuesday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Expected Wednesday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Expected Thursday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Expected Friday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Expected Saturday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Expected Sunday attendance: WorkingFromOffice or WorkingRemotely.. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Example Response