Get one Coworker

GET

api

spaces

coworkers

{id}

Get one Coworker

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkers/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkers/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerType": 123,
  "Businesses": [
    123
  ],
  "Teams": [
    123
  ],
  "FullName": "<string>",
  "Salutation": "<string>",
  "Gender": 123,
  "Email": "<string>",
  "CreateUser": true,
  "AvatarFileName": "<string>",
  "NewAvatarUrl": "<string>",
  "ClearAvatarFile": true,
  "BannerImageFileName": "<string>",
  "NewBannerImageUrl": "<string>",
  "ClearBannerImageFile": true,
  "Address": "<string>",
  "PostCode": "<string>",
  "CityName": "<string>",
  "State": "<string>",
  "CountryId": 123,
  "SimpleTimeZoneId": 123,
  "MobilePhone": "<string>",
  "LandLine": "<string>",
  "DateOfBirth": "<string>",
  "NickName": "<string>",
  "BusinessArea": "<string>",
  "Position": "<string>",
  "CompanyName": "<string>",
  "ProfileWebsite": "<string>",
  "ProfileTags": "<string>",
  "ProfileSummary": "<string>",
  "Twitter": "<string>",
  "Facebook": "<string>",
  "Google": "<string>",
  "Telegram": "<string>",
  "Linkedin": "<string>",
  "Skype": "<string>",
  "Github": "<string>",
  "Pinterest": "<string>",
  "Flickr": "<string>",
  "Instagram": "<string>",
  "Vimeo": "<string>",
  "Tumblr": "<string>",
  "Blogger": "<string>",
  "ProfileIsPublic": true,
  "InvoicingBusinessId": 123,
  "InvoicingBusinessName": "<string>",
  "BillingEmail": "<string>",
  "BillingName": "<string>",
  "BillingAddress": "<string>",
  "BillingPostCode": "<string>",
  "BillingCityName": "<string>",
  "BillingState": "<string>",
  "BillingCountryId": 123,
  "BillingSimpleTimeZoneId": 123,
  "TaxRateType": 123,
  "TaxRate": 123,
  "TaxIDNumber": "<string>",
  "BankName": "<string>",
  "BankAccount": "<string>",
  "BankBranch": "<string>",
  "NotifyOnNewInvoice": true,
  "NotifyOnNewPayment": true,
  "NotifyOnFailedPayment": true,
  "ShowPayingMemberInvoices": true,
  "EnableGoCardlessPayments": true,
  "UseGoCardlessProPayments": true,
  "GoCardlessContractNumber": "<string>",
  "StripeBacsDDPaymentMethodId": "<string>",
  "StripeBacsDDMandateId": "<string>",
  "StripeBacsDDCustomerToken": "<string>",
  "StripeBacsDDEnabled": true,
  "LastOverDueInvoiceReminder": "<string>",
  "LastLowCreditReminder": "<string>",
  "RefererGuid": "<string>",
  "RegularPaymentProvider": 123,
  "RegularPaymentContractNumber": "<string>",
  "CardNumber": "<string>",
  "DoNotProcessInvoicesAutomatically": true,
  "AllowNetworkCheckin": true,
  "CheckinSinceLastRenewal": 123,
  "MinutesSinceLastRenewal": 123,
  "AccessCardId": "<string>",
  "AccessPincode": "<string>",
  "KeyFobNumber": "<string>",
  "NotifyOnDelivery": true,
  "EzeepUserId": "<string>",
  "EzeepFreePrinting": true,
  "EzeepBlueUserId": "<string>",
  "EzeepBlueFreePrinting": true,
  "EzeepBluePrintingEnabled": true,
  "PaperCutPayAsYouPrint": true,
  "PaperCutFreePrinting": true,
  "PaperCutUserId": "<string>",
  "CanMakeBookings": true,
  "CanBookForTeam": true,
  "CanPurchaseProducts": true,
  "CanPurchaseEvents": true,
  "CanAccessCommunity": true,
  "ReferenceNumber": "<string>",
  "Tag": "<string>",
  "Notes": "<string>",
  "ShowAlert": true,
  "AlertNote": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserIsAdmin": true,
  "UserLastAccess": "<string>",
  "UserActive": true,
  "UserReceiveCommunityDigest": true,
  "UserReceiveEveryMessage": true,
  "Active": true,
  "NextAutoInvoice": "<string>",
  "InvoiceDueDatePeriod": 123,
  "RegistrationDate": "<string>",
  "GeneralTermsAccepted": true,
  "LastRenewal": "<string>",
  "LastInvoiceAttempt": "<string>",
  "Custom1": "<string>",
  "Custom2": "<string>",
  "Custom3": "<string>",
  "Custom4": "<string>",
  "Custom5": "<string>",
  "Custom6": "<string>",
  "Custom7": "<string>",
  "Custom8": "<string>",
  "Custom9": "<string>",
  "Custom10": "<string>",
  "Custom11": "<string>",
  "Custom12": "<string>",
  "Custom13": "<string>",
  "Custom14": "<string>",
  "Custom15": "<string>",
  "Custom16": "<string>",
  "Custom17": "<string>",
  "Custom18": "<string>",
  "Custom19": "<string>",
  "Custom20": "<string>",
  "Custom21": "<string>",
  "Custom22": "<string>",
  "Custom23": "<string>",
  "Custom24": "<string>",
  "Custom25": "<string>",
  "Custom26": "<string>",
  "Custom27": "<string>",
  "Custom28": "<string>",
  "Custom29": "<string>",
  "Custom30": "<string>",
  "NextInvoiceLocal": "<string>",
  "NextAutoInvoiceLocal": "<string>",
  "RegistrationDateLocal": "<string>",
  "AccessControlDebounceTime": "<string>",
  "Office365AccessToken": "<string>",
  "Office365RefreshToken": "<string>",
  "ZoomAccessToken": "<string>",
  "ZoomRefreshToken": "<string>",
  "ZoomUserId": "<string>",
  "DoordeckPrivateKey": "<string>",
  "DoordeckPublicKey": "<string>",
  "DoordeckUserGuid": "<string>",
  "Office365SubscriptionId": "<string>",
  "SaltoV2AccessToken": "<string>",
  "StripeACHBankToken": "<string>",
  "StripeACHCustomerToken": "<string>",
  "HasAcceptedStripeACHAgreement": true,
  "HasVerifiedStripeACHDeposits": true,
  "PurchaseOrder": "<string>",
  "SyncToSquare": true,
  "NotifyOnDeliveriesEmail": "<string>",
  "AccessControlErrorNotificationSent": true,
  "SyncToPaperCutDue": true,
  "GoogleApiToken": "<string>",
  "GoogleSubscriptionId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractTariffNames": "<string>",
  "BillingDay": 123,
  "TariffId": 123,
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "RenewalDate": "<string>",
  "TeamName": "<string>",
  "TeamId": 123,
  "TeamNames": "<string>",
  "TeamIds": "<string>",
  "CurrentAccessSignature": "<string>",
  "CurrentAccessSignatures": "<string>",
  "InvoiceSegregationOverride": true,
  "InvoiceSegregateContracts": true,
  "InvoiceSegregateBookings": true,
  "InvoiceSegregateProducts": true,
  "InvoiceSegregateTimePasses": true,
  "InvoiceSegregateTickets": true,
  "IsDefaultProfile": true,
  "InvoiceSegregateCharges": true,
  "BrivoUserId": 123,
  "EzeepPrintingEnabled": true,
  "ChurnProbability": 123,
  "EngagementLevel": "<string>",
  "InvoiceDueDateDay": 123,
  "MondayAttendance": 123,
  "TuesdayAttendance": 123,
  "WednesdayAttendance": 123,
  "ThursdayAttendance": 123,
  "FridayAttendance": 123,
  "SaturdayAttendance": 123,
  "SundayAttendance": 123,
  "Longitude": 123,
  "Latitude": 123,
  "BillingLongitude": 123,
  "BillingLatitude": 123,
  "Archived": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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, set 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

integer

required

The Id of the Coworker record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkers/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkers/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkers/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

Coworker type. See eCoworkerRecordType enum values: 1 = Individual, 2 = Company.

integer[]

List of businesses linked to this record.

integer[]

List of teams linked to this record.

string

Full name.

string

Title or salutation prefix (e.g. Mr, Mrs, Dr).

integer

Gender of the person. See eGender enum values: 0 = None, 1 = NotSet, 2 = Male, 3 = Female, 4 = Other, 5 = RatherNotSay.

string

Email address.

boolean

Create user account. Grants portal and app access and sends a welcome email with the access details.

string

Current file name of the avatar (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the avatar.

boolean

Set to true to remove the current avatar file.

string

Current file name of the banner image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the banner image.

boolean

Set to true to remove the current banner image file.

string

Street address.

string

Post code.

string

City name.

string

State or province.

integer

ID of the country linked to this record.

integer

ID of the simple time zone linked to this record.

string

Mobile phone.

string

Land line.

string

Date of birth.

string

Nickname.

string

Business area.

string

Display order position or job title.

string

Company name.

string

Profile website.

string

Profile tags.

string

Profile summary.

string

Twitter handle.

string

Facebook profile.

string

The google value for this coworker.

string

Telegram handle.

string

LinkedIn profile.

string

Skype handle.

string

GitHub profile.

string

The pinterest value for this coworker.

string

The flickr value for this coworker.

string

Instagram profile.

string

The vimeo value for this coworker.

string

The tumblr value for this coworker.

string

The blogger value for this coworker.

boolean

Profile is public.

integer

ID of the invoicing business linked to this record.

string

The name of the customer home location.

string

Billing email.

string

Billing name.

string

Billing address.

string

Billing post code.

string

Billing city.

string

Billing state.

integer

ID of the billing country linked to this record.

integer

ID of the billing simple time zone linked to this record.

integer

Tax rate type. See eCoworkerTaxRateType enum values: 1 = Default, 2 = Reduced, 3 = Exempt.

number

Tax rate.

string

Tax ID number.

string

Bank name.

string

Bank account.

string

Bank branch.

boolean

Notify on new invoice.

boolean

Notify on new payment.

boolean

Notify on failed payment.

boolean

Show paying member invoices.

boolean

Enable GoCardless payments.

boolean

Whether use go cardless pro payments is enabled.

string

GoCardless contract number.

string

ID of the stripe bacs dd payment method associated with this record.

string

ID of the stripe bacs dd mandate associated with this record.

string

The stripe bacs dd customer token value for this coworker.

boolean

Whether stripe bacs dd enabled is enabled.

string

Date/time value for last over due invoice reminder.

string

Date/time value for last low credit reminder.

string

Unique identifier (GUID) for the referer.

integer

Regular payment provider.

string

Regular payment contract number.

string

Card number.

boolean

Do not process invoices automatically.

boolean

Allow network check-in.

integer

Check-ins since last renewal.

integer

Minutes since last renewal.

string

Access card ID.

string

Access PIN code.

string

Key fob number.

boolean

Notify on delivery.

string

ID of the ezeep user associated with this record.

boolean

Whether ezeep free printing is enabled.

string

ID of the ezeep blue user associated with this record.

boolean

Whether ezeep blue free printing is enabled.

boolean

Whether ezeep blue printing enabled is enabled.

boolean

Whether paper cut pay as you print is enabled.

boolean

Whether paper cut free printing is enabled.

string

ID of the paper cut user associated with this record.

boolean

Can make bookings.

boolean

Can book for team.

boolean

Can purchase products.

boolean

Can purchase events.

boolean

Can access community.

string

Reference number.

string

Free-form tag for categorising or filtering.

string

Optional notes or comments about this coworker.

boolean

Show alert.

string

Alert note.

integer

ID of the user linked to this record.

string

Display name of the linked user full (read-only).

boolean

Whether user is admin is enabled.

string

Date/time value for user last access.

boolean

Whether user active is enabled.

boolean

Whether user receive community digest is enabled.

boolean

Whether user receive every message is enabled.

boolean

Whether this coworker is currently active.

string

Next auto invoice date.

integer

Invoice due date period.

string

Registration date.

boolean

General terms accepted.

string

Date/time value for last renewal.

string

Date/time value for last invoice attempt.

string

Custom field 1.

string

Custom field 2.

string

Custom field 3.

string

Custom field 4.

string

Custom field 5.

string

Custom field 6.

string

Custom field 7.

string

Custom field 8.

string

Custom field 9.

string

Custom field 10.

string

Custom field 11.

string

Custom field 12.

string

Custom field 13.

string

Custom field 14.

string

Custom field 15.

string

Custom field 16.

string

Custom field 17.

string

Custom field 18.

string

Custom field 19.

string

Custom field 20.

string

Custom field 21.

string

Custom field 22.

string

Custom field 23.

string

Custom field 24.

string

Custom field 25.

string

Custom field 26.

string

Custom field 27.

string

Custom field 28.

string

Custom field 29.

string

Custom field 30.

string

Date/time value for next invoice local.

string

Date/time value for next auto invoice local.

string

Date/time value for registration date local.

string

Date/time value for access control debounce time.

string

The office365 access token value for this coworker.

string

The office365 refresh token value for this coworker.

string

The zoom access token value for this coworker.

string

The zoom refresh token value for this coworker.

string

ID of the zoom user associated with this record.

string

The doordeck private key value for this coworker.

string

The doordeck public key value for this coworker.

string

Unique identifier (GUID) for the doordeck user.

string

ID of the office365 subscription associated with this record.

string

The salto v2 access token value for this coworker.

string

The stripe ach bank token value for this coworker.

string

The stripe ach customer token value for this coworker.

boolean

Whether has accepted stripe ach agreement is enabled.

boolean

Whether has verified stripe ach deposits is enabled.

string

Purchase order.

boolean

Whether sync to square is enabled.

string

Notify on deliveries email.

boolean

Whether access control error notification sent is enabled.

boolean

Whether sync to paper cut due is enabled.

string

The google api token value for this coworker.

string

ID of the google subscription associated with this record.

string

The coworker contract ids value for this coworker.

string

The coworker contract tariff names value for this coworker.

integer

Billing day. Used with TariffId to fix the billing day (defaults to current day or the plan’s default billing day).

integer

Plan ID. Creates a new contract for this plan at the same time as the customer. Combine with BillingDay and RenewalDate.

integer

Tariff invoice every N months.

integer

Tariff invoice every N weeks.

string

Renewal date. Used with TariffId as the date when the plan starts and will be invoiced first.

string

Display name of the linked team (read-only).

integer

ID of the team associated with this record.

string

Team names.

string

The team ids value for this coworker.

string

The current access signature value for this coworker.

string

The current access signatures value for this coworker.

boolean

Whether invoice segregation override is enabled.

boolean

Whether invoice segregate contracts is enabled.

boolean

Whether invoice segregate bookings is enabled.

boolean

Whether invoice segregate products is enabled.

boolean

Whether invoice segregate time passes is enabled.

boolean

Whether invoice segregate tickets is enabled.

boolean

Whether is default profile is enabled.

boolean

Whether invoice segregate charges is enabled.

integer

ID of the brivo user associated with this record.

boolean

Whether ezeep printing enabled is enabled.

number

The churn probability value for this coworker.

string

The engagement level value for this coworker.

integer

The invoice due date day value for this coworker.

integer

Monday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

integer

Tuesday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

integer

Wednesday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

integer

Thursday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

integer

Friday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

integer

Saturday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

integer

Sunday attendance. See eCoworkerAttendance enum values: 1 = WorkingFromOffice, 2 = WorkingFromHome, 3 = WorkingFromAbroad, 4 = NotWorking, 5 = Undefined.

number

GPS longitude coordinate.

number

GPS latitude coordinate.

number

Billing longitude.

number

Billing latitude.

boolean

Whether this coworker is archived and hidden from active lists.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "CoworkerType": 0,
  "Businesses": [],
  "Teams": [],
  "FullName": "",
  "Salutation": null,
  "Gender": 0,
  "Email": "",
  "CreateUser": false,
  "AvatarFileName": null,
  "NewAvatarUrl": null,
  "ClearAvatarFile": null,
  "BannerImageFileName": null,
  "NewBannerImageUrl": null,
  "ClearBannerImageFile": null,
  "Address": null,
  "PostCode": null,
  "CityName": null,
  "State": null,
  "CountryId": 0,
  "SimpleTimeZoneId": 0,
  "MobilePhone": null,
  "LandLine": null,
  "DateOfBirth": null,
  "NickName": null,
  "BusinessArea": null,
  "Position": null,
  "CompanyName": null,
  "ProfileWebsite": null,
  "ProfileTags": null,
  "ProfileSummary": null,
  "Twitter": null,
  "Facebook": null,
  "Google": null,
  "Telegram": null,
  "Linkedin": null,
  "Skype": null,
  "Github": null,
  "Pinterest": null,
  "Flickr": null,
  "Instagram": null,
  "Vimeo": null,
  "Tumblr": null,
  "Blogger": null,
  "ProfileIsPublic": false,
  "InvoicingBusinessId": null,
  "InvoicingBusinessName": null,
  "BillingEmail": null,
  "BillingName": null,
  "BillingAddress": null,
  "BillingPostCode": null,
  "BillingCityName": null,
  "BillingState": null,
  "BillingCountryId": null,
  "BillingSimpleTimeZoneId": null,
  "TaxRateType": 0,
  "TaxRate": null,
  "TaxIDNumber": null,
  "BankName": null,
  "BankAccount": null,
  "BankBranch": null,
  "NotifyOnNewInvoice": false,
  "NotifyOnNewPayment": false,
  "NotifyOnFailedPayment": false,
  "ShowPayingMemberInvoices": false,
  "EnableGoCardlessPayments": false,
  "UseGoCardlessProPayments": false,
  "GoCardlessContractNumber": null,
  "StripeBacsDDPaymentMethodId": null,
  "StripeBacsDDMandateId": null,
  "StripeBacsDDCustomerToken": null,
  "StripeBacsDDEnabled": false,
  "LastOverDueInvoiceReminder": null,
  "LastLowCreditReminder": null,
  "RefererGuid": null,
  "RegularPaymentProvider": 0,
  "RegularPaymentContractNumber": null,
  "CardNumber": null,
  "DoNotProcessInvoicesAutomatically": false,
  "AllowNetworkCheckin": false,
  "CheckinSinceLastRenewal": 0,
  "MinutesSinceLastRenewal": 0,
  "AccessCardId": null,
  "AccessPincode": null,
  "KeyFobNumber": null,
  "NotifyOnDelivery": false,
  "EzeepUserId": null,
  "EzeepFreePrinting": false,
  "EzeepBlueUserId": null,
  "EzeepBlueFreePrinting": false,
  "EzeepBluePrintingEnabled": false,
  "PaperCutPayAsYouPrint": false,
  "PaperCutFreePrinting": false,
  "PaperCutUserId": null,
  "CanMakeBookings": false,
  "CanBookForTeam": false,
  "CanPurchaseProducts": false,
  "CanPurchaseEvents": false,
  "CanAccessCommunity": false,
  "ReferenceNumber": null,
  "Tag": null,
  "Notes": null,
  "ShowAlert": false,
  "AlertNote": null,
  "UserId": null,
  "UserFullName": null,
  "UserIsAdmin": null,
  "UserLastAccess": null,
  "UserActive": null,
  "UserReceiveCommunityDigest": null,
  "UserReceiveEveryMessage": null,
  "Active": false,
  "NextAutoInvoice": null,
  "InvoiceDueDatePeriod": null,
  "RegistrationDate": null,
  "GeneralTermsAccepted": false,
  "LastRenewal": null,
  "LastInvoiceAttempt": null,
  "Custom1": null,
  "Custom2": null,
  "Custom3": null,
  "Custom4": null,
  "Custom5": null,
  "Custom6": null,
  "Custom7": null,
  "Custom8": null,
  "Custom9": null,
  "Custom10": null,
  "Custom11": null,
  "Custom12": null,
  "Custom13": null,
  "Custom14": null,
  "Custom15": null,
  "Custom16": null,
  "Custom17": null,
  "Custom18": null,
  "Custom19": null,
  "Custom20": null,
  "Custom21": null,
  "Custom22": null,
  "Custom23": null,
  "Custom24": null,
  "Custom25": null,
  "Custom26": null,
  "Custom27": null,
  "Custom28": null,
  "Custom29": null,
  "Custom30": null,
  "NextInvoiceLocal": null,
  "NextAutoInvoiceLocal": null,
  "RegistrationDateLocal": null,
  "AccessControlDebounceTime": null,
  "Office365AccessToken": null,
  "Office365RefreshToken": null,
  "ZoomAccessToken": null,
  "ZoomRefreshToken": null,
  "ZoomUserId": null,
  "DoordeckPrivateKey": null,
  "DoordeckPublicKey": null,
  "DoordeckUserGuid": null,
  "Office365SubscriptionId": null,
  "SaltoV2AccessToken": null,
  "StripeACHBankToken": null,
  "StripeACHCustomerToken": null,
  "HasAcceptedStripeACHAgreement": false,
  "HasVerifiedStripeACHDeposits": false,
  "PurchaseOrder": null,
  "SyncToSquare": false,
  "NotifyOnDeliveriesEmail": null,
  "AccessControlErrorNotificationSent": false,
  "SyncToPaperCutDue": false,
  "GoogleApiToken": null,
  "GoogleSubscriptionId": null,
  "CoworkerContractIds": null,
  "CoworkerContractTariffNames": null,
  "BillingDay": null,
  "TariffId": null,
  "TariffInvoiceEvery": 0,
  "TariffInvoiceEveryWeeks": 0,
  "RenewalDate": null,
  "TeamName": null,
  "TeamId": null,
  "TeamNames": null,
  "TeamIds": null,
  "CurrentAccessSignature": null,
  "CurrentAccessSignatures": null,
  "InvoiceSegregationOverride": false,
  "InvoiceSegregateContracts": false,
  "InvoiceSegregateBookings": false,
  "InvoiceSegregateProducts": false,
  "InvoiceSegregateTimePasses": false,
  "InvoiceSegregateTickets": false,
  "IsDefaultProfile": false,
  "InvoiceSegregateCharges": false,
  "BrivoUserId": null,
  "EzeepPrintingEnabled": false,
  "ChurnProbability": null,
  "EngagementLevel": null,
  "InvoiceDueDateDay": null,
  "MondayAttendance": 0,
  "TuesdayAttendance": 0,
  "WednesdayAttendance": 0,
  "ThursdayAttendance": 0,
  "FridayAttendance": 0,
  "SaturdayAttendance": 0,
  "SundayAttendance": 0,
  "Longitude": null,
  "Latitude": null,
  "BillingLongitude": null,
  "BillingLatitude": null,
  "Archived": false,
  "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": "Coworker Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkersRetrieve multiple Coworker records by their Ids in a single request.

Get one Coworker

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkers/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkers/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerType": 123,
  "Businesses": [
    123
  ],
  "Teams": [
    123
  ],
  "FullName": "<string>",
  "Salutation": "<string>",
  "Gender": 123,
  "Email": "<string>",
  "CreateUser": true,
  "AvatarFileName": "<string>",
  "NewAvatarUrl": "<string>",
  "ClearAvatarFile": true,
  "BannerImageFileName": "<string>",
  "NewBannerImageUrl": "<string>",
  "ClearBannerImageFile": true,
  "Address": "<string>",
  "PostCode": "<string>",
  "CityName": "<string>",
  "State": "<string>",
  "CountryId": 123,
  "SimpleTimeZoneId": 123,
  "MobilePhone": "<string>",
  "LandLine": "<string>",
  "DateOfBirth": "<string>",
  "NickName": "<string>",
  "BusinessArea": "<string>",
  "Position": "<string>",
  "CompanyName": "<string>",
  "ProfileWebsite": "<string>",
  "ProfileTags": "<string>",
  "ProfileSummary": "<string>",
  "Twitter": "<string>",
  "Facebook": "<string>",
  "Google": "<string>",
  "Telegram": "<string>",
  "Linkedin": "<string>",
  "Skype": "<string>",
  "Github": "<string>",
  "Pinterest": "<string>",
  "Flickr": "<string>",
  "Instagram": "<string>",
  "Vimeo": "<string>",
  "Tumblr": "<string>",
  "Blogger": "<string>",
  "ProfileIsPublic": true,
  "InvoicingBusinessId": 123,
  "InvoicingBusinessName": "<string>",
  "BillingEmail": "<string>",
  "BillingName": "<string>",
  "BillingAddress": "<string>",
  "BillingPostCode": "<string>",
  "BillingCityName": "<string>",
  "BillingState": "<string>",
  "BillingCountryId": 123,
  "BillingSimpleTimeZoneId": 123,
  "TaxRateType": 123,
  "TaxRate": 123,
  "TaxIDNumber": "<string>",
  "BankName": "<string>",
  "BankAccount": "<string>",
  "BankBranch": "<string>",
  "NotifyOnNewInvoice": true,
  "NotifyOnNewPayment": true,
  "NotifyOnFailedPayment": true,
  "ShowPayingMemberInvoices": true,
  "EnableGoCardlessPayments": true,
  "UseGoCardlessProPayments": true,
  "GoCardlessContractNumber": "<string>",
  "StripeBacsDDPaymentMethodId": "<string>",
  "StripeBacsDDMandateId": "<string>",
  "StripeBacsDDCustomerToken": "<string>",
  "StripeBacsDDEnabled": true,
  "LastOverDueInvoiceReminder": "<string>",
  "LastLowCreditReminder": "<string>",
  "RefererGuid": "<string>",
  "RegularPaymentProvider": 123,
  "RegularPaymentContractNumber": "<string>",
  "CardNumber": "<string>",
  "DoNotProcessInvoicesAutomatically": true,
  "AllowNetworkCheckin": true,
  "CheckinSinceLastRenewal": 123,
  "MinutesSinceLastRenewal": 123,
  "AccessCardId": "<string>",
  "AccessPincode": "<string>",
  "KeyFobNumber": "<string>",
  "NotifyOnDelivery": true,
  "EzeepUserId": "<string>",
  "EzeepFreePrinting": true,
  "EzeepBlueUserId": "<string>",
  "EzeepBlueFreePrinting": true,
  "EzeepBluePrintingEnabled": true,
  "PaperCutPayAsYouPrint": true,
  "PaperCutFreePrinting": true,
  "PaperCutUserId": "<string>",
  "CanMakeBookings": true,
  "CanBookForTeam": true,
  "CanPurchaseProducts": true,
  "CanPurchaseEvents": true,
  "CanAccessCommunity": true,
  "ReferenceNumber": "<string>",
  "Tag": "<string>",
  "Notes": "<string>",
  "ShowAlert": true,
  "AlertNote": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserIsAdmin": true,
  "UserLastAccess": "<string>",
  "UserActive": true,
  "UserReceiveCommunityDigest": true,
  "UserReceiveEveryMessage": true,
  "Active": true,
  "NextAutoInvoice": "<string>",
  "InvoiceDueDatePeriod": 123,
  "RegistrationDate": "<string>",
  "GeneralTermsAccepted": true,
  "LastRenewal": "<string>",
  "LastInvoiceAttempt": "<string>",
  "Custom1": "<string>",
  "Custom2": "<string>",
  "Custom3": "<string>",
  "Custom4": "<string>",
  "Custom5": "<string>",
  "Custom6": "<string>",
  "Custom7": "<string>",
  "Custom8": "<string>",
  "Custom9": "<string>",
  "Custom10": "<string>",
  "Custom11": "<string>",
  "Custom12": "<string>",
  "Custom13": "<string>",
  "Custom14": "<string>",
  "Custom15": "<string>",
  "Custom16": "<string>",
  "Custom17": "<string>",
  "Custom18": "<string>",
  "Custom19": "<string>",
  "Custom20": "<string>",
  "Custom21": "<string>",
  "Custom22": "<string>",
  "Custom23": "<string>",
  "Custom24": "<string>",
  "Custom25": "<string>",
  "Custom26": "<string>",
  "Custom27": "<string>",
  "Custom28": "<string>",
  "Custom29": "<string>",
  "Custom30": "<string>",
  "NextInvoiceLocal": "<string>",
  "NextAutoInvoiceLocal": "<string>",
  "RegistrationDateLocal": "<string>",
  "AccessControlDebounceTime": "<string>",
  "Office365AccessToken": "<string>",
  "Office365RefreshToken": "<string>",
  "ZoomAccessToken": "<string>",
  "ZoomRefreshToken": "<string>",
  "ZoomUserId": "<string>",
  "DoordeckPrivateKey": "<string>",
  "DoordeckPublicKey": "<string>",
  "DoordeckUserGuid": "<string>",
  "Office365SubscriptionId": "<string>",
  "SaltoV2AccessToken": "<string>",
  "StripeACHBankToken": "<string>",
  "StripeACHCustomerToken": "<string>",
  "HasAcceptedStripeACHAgreement": true,
  "HasVerifiedStripeACHDeposits": true,
  "PurchaseOrder": "<string>",
  "SyncToSquare": true,
  "NotifyOnDeliveriesEmail": "<string>",
  "AccessControlErrorNotificationSent": true,
  "SyncToPaperCutDue": true,
  "GoogleApiToken": "<string>",
  "GoogleSubscriptionId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractTariffNames": "<string>",
  "BillingDay": 123,
  "TariffId": 123,
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "RenewalDate": "<string>",
  "TeamName": "<string>",
  "TeamId": 123,
  "TeamNames": "<string>",
  "TeamIds": "<string>",
  "CurrentAccessSignature": "<string>",
  "CurrentAccessSignatures": "<string>",
  "InvoiceSegregationOverride": true,
  "InvoiceSegregateContracts": true,
  "InvoiceSegregateBookings": true,
  "InvoiceSegregateProducts": true,
  "InvoiceSegregateTimePasses": true,
  "InvoiceSegregateTickets": true,
  "IsDefaultProfile": true,
  "InvoiceSegregateCharges": true,
  "BrivoUserId": 123,
  "EzeepPrintingEnabled": true,
  "ChurnProbability": 123,
  "EngagementLevel": "<string>",
  "InvoiceDueDateDay": 123,
  "MondayAttendance": 123,
  "TuesdayAttendance": 123,
  "WednesdayAttendance": 123,
  "ThursdayAttendance": 123,
  "FridayAttendance": 123,
  "SaturdayAttendance": 123,
  "SundayAttendance": 123,
  "Longitude": 123,
  "Latitude": 123,
  "BillingLongitude": 123,
  "BillingLatitude": 123,
  "Archived": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200