Coworkers
Get one Coworker
Retrieve a single Coworker record by its Id.
GET
Get one Coworker
A Coworker represents a customer in Nexudus. Coworkers can be individuals or companies and hold all personal, billing, access-control, and plan information for a customer. When creating a coworker, setDocumentation Index
Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
Use this file to discover all available pages before exploring further.
CreateUser to grant portal and app access — this also sends a welcome email with access details.
To assign a plan at creation time, pass TariffId with the plan ID. Combine with BillingDay to fix the billing day (defaults to the current day or the plan’s default billing day) and RenewalDate to set the date when the plan starts and will first be invoiced.
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
The Id of the Coworker record to retrieve.
Code Examples
Response
200
Coworker type. See
eCoworkerRecordType enum values: 1 = Individual, 2 = Company.List of businesses linked to this record.
List of teams linked to this record.
Full name.
Title or salutation prefix (e.g. Mr, Mrs, Dr).
Gender of the person. See
eGender enum values: 0 = None, 1 = NotSet, 2 = Male, 3 = Female, 4 = Other, 5 = RatherNotSay.Email address.
Create user account. Grants portal and app access and sends a welcome email with the access details.
Current file name of the avatar (read-only; upload via the corresponding URL field).
URL of a new file to upload as the avatar.
Set to true to remove the current avatar file.
Current file name of the banner image (read-only; upload via the corresponding URL field).
URL of a new file to upload as the banner image.
Set to true to remove the current banner image file.
Street address.
Post code.
City name.
State or province.
ID of the country linked to this record.
ID of the simple time zone linked to this record.
Mobile phone.
Land line.
Date of birth.
Nickname.
Business area.
Display order position or job title.
Company name.
Profile website.
Profile tags.
Profile summary.
Twitter handle.
Facebook profile.
The google value for this coworker.
Telegram handle.
LinkedIn profile.
Skype handle.
GitHub profile.
The pinterest value for this coworker.
The flickr value for this coworker.
Instagram profile.
The vimeo value for this coworker.
The tumblr value for this coworker.
The blogger value for this coworker.
Profile is public.
ID of the invoicing business linked to this record.
The name of the customer home location.
Billing email.
Billing name.
Billing address.
Billing post code.
Billing city.
Billing state.
ID of the billing country linked to this record.
ID of the billing simple time zone linked to this record.
Tax rate type. See
eCoworkerTaxRateType enum values: 1 = Default, 2 = Reduced, 3 = Exempt.Tax rate.
Tax ID number.
Bank name.
Bank account.
Bank branch.
Notify on new invoice.
Notify on new payment.
Notify on failed payment.
Show paying member invoices.
Enable GoCardless payments.
Whether use go cardless pro payments is enabled.
GoCardless contract number.
ID of the stripe bacs dd payment method associated with this record.
ID of the stripe bacs dd mandate associated with this record.
The stripe bacs dd customer token value for this coworker.
Whether stripe bacs dd enabled is enabled.
Date/time value for last over due invoice reminder.
Date/time value for last low credit reminder.
Unique identifier (GUID) for the referer.
Regular payment provider.
Regular payment contract number.
Card number.
Do not process invoices automatically.
Allow network check-in.
Check-ins since last renewal.
Minutes since last renewal.
Access card ID.
Access PIN code.
Key fob number.
Notify on delivery.
ID of the ezeep user associated with this record.
Whether ezeep free printing is enabled.
ID of the ezeep blue user associated with this record.
Whether ezeep blue free printing is enabled.
Whether ezeep blue printing enabled is enabled.
Whether paper cut pay as you print is enabled.
Whether paper cut free printing is enabled.
ID of the paper cut user associated with this record.
Can make bookings.
Can book for team.
Can purchase products.
Can purchase events.
Can access community.
Reference number.
Free-form tag for categorising or filtering.
Optional notes or comments about this coworker.
Show alert.
Alert note.
ID of the user linked to this record.
Display name of the linked user full (read-only).
Whether user is admin is enabled.
Date/time value for user last access.
Whether user active is enabled.
Whether user receive community digest is enabled.
Whether user receive every message is enabled.
Whether this coworker is currently active.
Next auto invoice date.
Invoice due date period.
Registration date.
General terms accepted.
Date/time value for last renewal.
Date/time value for last invoice attempt.
Custom field 1.
Custom field 2.
Custom field 3.
Custom field 4.
Custom field 5.
Custom field 6.
Custom field 7.
Custom field 8.
Custom field 9.
Custom field 10.
Custom field 11.
Custom field 12.
Custom field 13.
Custom field 14.
Custom field 15.
Custom field 16.
Custom field 17.
Custom field 18.
Custom field 19.
Custom field 20.
Custom field 21.
Custom field 22.
Custom field 23.
Custom field 24.
Custom field 25.
Custom field 26.
Custom field 27.
Custom field 28.
Custom field 29.
Custom field 30.
Date/time value for next invoice local.
Date/time value for next auto invoice local.
Date/time value for registration date local.
Date/time value for access control debounce time.
The office365 access token value for this coworker.
The office365 refresh token value for this coworker.
The zoom access token value for this coworker.
The zoom refresh token value for this coworker.
ID of the zoom user associated with this record.
The doordeck private key value for this coworker.
The doordeck public key value for this coworker.
Unique identifier (GUID) for the doordeck user.
ID of the office365 subscription associated with this record.
The salto v2 access token value for this coworker.
The stripe ach bank token value for this coworker.
The stripe ach customer token value for this coworker.
Whether has accepted stripe ach agreement is enabled.
Whether has verified stripe ach deposits is enabled.
Purchase order.
Whether sync to square is enabled.
Notify on deliveries email.
Whether access control error notification sent is enabled.
Whether sync to paper cut due is enabled.
The google api token value for this coworker.
ID of the google subscription associated with this record.
The coworker contract ids value for this coworker.
The coworker contract tariff names value for this coworker.
Billing day. Used with
TariffId to fix the billing day (defaults to current day or the plan’s default billing day).Plan ID. Creates a new contract for this plan at the same time as the customer. Combine with
BillingDay and RenewalDate.Tariff invoice every N months.
Tariff invoice every N weeks.
Renewal date. Used with
TariffId as the date when the plan starts and will be invoiced first.Display name of the linked team (read-only).
ID of the team associated with this record.
Team names.
The team ids value for this coworker.
The current access signature value for this coworker.
The current access signatures value for this coworker.
Whether invoice segregation override is enabled.
Whether invoice segregate contracts is enabled.
Whether invoice segregate bookings is enabled.
Whether invoice segregate products is enabled.
Whether invoice segregate time passes is enabled.
Whether invoice segregate tickets is enabled.
Whether is default profile is enabled.
Whether invoice segregate charges is enabled.
ID of the brivo user associated with this record.
Whether ezeep printing enabled is enabled.
The churn probability value for this coworker.
The engagement level value for this coworker.
The invoice due date day value for this coworker.
Monday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Tuesday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Wednesday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Thursday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Friday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Saturday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.Sunday attendance. See
eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.GPS longitude coordinate.
GPS latitude coordinate.
Billing longitude.
Billing latitude.
Whether this coworker is archived and hidden from active lists.
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.
Example Response
Get one Coworker