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

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

Whether this customer record represents an Individual or a Company.. See eCoworkerRecordType enum values: 1 = Individual, 2 = Company.

integer[]

List of location IDs where this customer is registered; replacing the list replaces all registrations..

integer[]

List of team IDs this customer belongs to; replacing the list replaces all team memberships..

string

Customer’s full name; required and limited to 254 characters..

string

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..

integer

Optional customer gender: NotSet, Male, Female, Other, or RatherNotSay.. See eGender enum values: 1 = NotSet, 2 = Male, 3 = Female, 4 = Other, 5 = RatherNotSay.

string

Customer email address; required by entity validation and used when creating an associated user account..

boolean

Whether to create the associated user account when this customer is first created; create-only..

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

Customer contact street address..

string

Customer contact postal or ZIP code, limited to 15 characters..

string

Customer contact city, limited to 50 characters..

string

Customer contact state, province, or region, limited to 255 characters..

integer

ID of the customer’s contact country; global reference data and required by entity validation..

integer

ID of the customer’s time zone; global reference data and required by entity validation..

string

Customer mobile telephone number, limited to 255 characters..

string

Customer landline or office telephone number, limited to 255 characters..

string

Optional customer date of birth..

string

Optional informal customer name, limited to 254 characters..

string

Customer’s professional sector or business area, limited to 254 characters..

string

Customer’s job title or role, limited to 254 characters..

string

Customer’s employer or company name..

string

Customer’s profile or company website URL, limited to 254 characters..

string

Customer profile tags as a text value, limited to 254 characters..

string

Customer’s public profile summary or biography, limited to 4,096 characters..

string

Customer’s Twitter profile or handle, limited to 254 characters..

string

Customer’s Facebook profile or handle, limited to 254 characters..

string

Customer’s Google profile or handle, limited to 254 characters..

string

Customer’s Telegram profile or handle, limited to 254 characters..

string

Customer’s LinkedIn profile or handle, limited to 254 characters..

string

Customer’s Skype profile or handle, limited to 254 characters..

string

Customer’s GitHub profile or handle, limited to 254 characters..

string

Customer’s Pinterest profile or handle, limited to 254 characters..

string

Customer’s Flickr profile or handle, limited to 254 characters..

string

Customer’s Instagram profile or handle, limited to 254 characters..

string

Customer’s Vimeo profile or handle, limited to 254 characters..

string

Customer’s Tumblr profile or handle, limited to 254 characters..

string

Customer’s Blogger profile or handle, limited to 254 characters..

boolean

Whether the customer’s profile is visible in the public member directory..

integer

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..

string

Display value for InvoicingBusiness.Name..

string

Email address to receive this customer’s invoices, limited to 254 characters..

string

Legal or trading name printed on invoices; when empty, invoices use the company name for Company customers or FullName otherwise..

string

Billing street address; when empty, invoices use the contact address..

string

Billing postal or ZIP code; when empty, invoices use the contact postal code..

string

Billing city; when empty, invoices use the contact city..

string

Billing state, province, or region; when empty, invoices use the contact state..

integer

ID of the country for invoice addresses; global reference data, with the contact country and then the location country used as fallbacks..

integer

ID of the time zone used for billing details; global reference data..

integer

Tax treatment for this customer: Default, Reduced, or Exempt.. See eCoworkerTaxRateType enum values: 1 = Default, 2 = Reduced, 3 = Exempt.

number

Optional non-negative tax percentage override for this customer..

string

Customer tax or VAT identification number, limited to 255 characters..

string

Bank name used for this customer’s regular-payment arrangement, limited to 255 characters..

string

Customer bank account identifier for a regular-payment arrangement; do not expose or set it through the agent..

string

Customer bank branch or sort code for a regular-payment arrangement; do not expose or set it through the agent..

boolean

Whether to notify the customer when a new invoice is created..

boolean

Whether to notify the customer when a payment is received..

boolean

Whether to notify the customer when an automatic payment fails..

boolean

Whether this customer can view invoices of their paying member when one exists..

boolean

Whether GoCardless regular payments are enabled for this customer..

boolean

Internal GoCardless Pro integration flag; managed by payment integration setup..

string

External GoCardless mandate or contract identifier; managed by the payment integration and not exposed to the agent..

string

Stripe BACS payment-method identifier; managed by the payment integration and not exposed to the agent..

string

Stripe BACS mandate identifier; managed by the payment integration and not exposed to the agent..

string

Stripe BACS customer token; security-sensitive integration credential not exposed to the agent..

boolean

Whether Stripe BACS direct-debit payments are enabled for this customer..

string

Timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent..

string

Timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent..

string

Internal referral tracking identifier; not exposed to the agent..

integer

Regular-payment provider selected for this customer; set by the supported payment flow rather than by manual provider assignment..

string

External regular-payment contract or mandate identifier managed by the payment provider..

string

Read-only last four digits of the customer’s payment card; supplied by the payment provider and not exposed to the agent..

boolean

Whether automatic invoice payment processing is disabled for this customer..

boolean

Whether this customer may check in through the network check-in integration..

integer

Read-only number of check-ins since the last allowance renewal; maintained from check-in activity..

integer

Read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity..

string

Physical access-card identifier; managed through access control and not exposed to the agent..

string

Access-control PIN; security-sensitive and not exposed to the agent..

string

Physical access key-fob identifier; managed through access control and not exposed to the agent..

boolean

Whether to notify this customer about deliveries for their team..

string

External Ezeep user ID used by the printing integration..

boolean

Whether this customer can print for free through Ezeep..

string

External Ezeep Blue user ID used by the printing integration..

boolean

Whether this customer can print for free through Ezeep Blue..

boolean

Internal Ezeep Blue printing synchronization flag; managed by the integration..

boolean

Whether PaperCut pay-as-you-print is enabled for this customer..

boolean

Whether this customer can print for free through PaperCut..

string

External PaperCut user identifier used by the printing integration..

boolean

Whether this customer may make bookings..

boolean

Whether this customer may make bookings on behalf of their team..

boolean

Whether this customer may purchase products..

boolean

Whether this customer may purchase event tickets..

boolean

Whether this customer may access the community feature..

string

Optional external or internal reference number for this customer..

string

Optional free-text tag used to classify this customer..

string

Internal notes about this customer..

boolean

Whether an alert should be shown when staff open this customer’s record..

string

Alert message displayed to staff when ShowAlert is enabled..

integer

ID of the optional user account linked to this customer; update-only because creating the account uses CreateUser..

string

Display value for User.FullName..

boolean

Display value for User.IsAdmin..

string

Display value for User.LastAccess..

boolean

Display value for User.Active..

boolean

Display value for User.ReceiveCommunityDigest..

boolean

Display value for User.ReceiveEveryMessage..

boolean

Whether this customer record is active..

string

Next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing..

integer

Optional number of days after issue date before this customer’s invoices are due..

string

Optional customer registration date..

boolean

Whether the customer has accepted the location’s general terms and conditions..

string

Timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent..

string

Timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent..

string

Optional custom customer field 1; its meaning is configured by the location..

string

Optional custom customer field 2; its meaning is configured by the location..

string

Optional custom customer field 3; its meaning is configured by the location..

string

Optional custom customer field 4; its meaning is configured by the location..

string

Optional custom customer field 5; its meaning is configured by the location..

string

Optional custom customer field 6; its meaning is configured by the location..

string

Optional custom customer field 7; its meaning is configured by the location..

string

Optional custom customer field 8; its meaning is configured by the location..

string

Optional custom customer field 9; its meaning is configured by the location..

string

Optional custom customer field 10; its meaning is configured by the location..

string

Optional custom customer field 11; its meaning is configured by the location..

string

Optional custom customer field 12; its meaning is configured by the location..

string

Optional custom customer field 13; its meaning is configured by the location..

string

Optional custom customer field 14; its meaning is configured by the location..

string

Optional custom customer field 15; its meaning is configured by the location..

string

Optional custom customer field 16; its meaning is configured by the location..

string

Optional custom customer field 17; its meaning is configured by the location..

string

Optional custom customer field 18; its meaning is configured by the location..

string

Optional custom customer field 19; its meaning is configured by the location..

string

Optional custom customer field 20; its meaning is configured by the location..

string

Optional custom customer field 21; its meaning is configured by the location..

string

Optional custom customer field 22; its meaning is configured by the location..

string

Optional custom customer field 23; its meaning is configured by the location..

string

Optional custom customer field 24; its meaning is configured by the location..

string

Optional custom customer field 25; its meaning is configured by the location..

string

Optional custom customer field 26; its meaning is configured by the location..

string

Optional custom customer field 27; its meaning is configured by the location..

string

Optional custom customer field 28; its meaning is configured by the location..

string

Optional custom customer field 29; its meaning is configured by the location..

string

Optional custom customer field 30; its meaning is configured by the location..

string

Localized invoice schedule value derived by the application; not exposed to the agent..

string

Localized next automatic-invoice value derived by the application; not exposed to the agent..

string

Localized registration-date value derived by the application; not exposed to the agent..

string

Internal access-control debounce timestamp; not exposed to the agent..

string

Microsoft 365 OAuth access token; security-sensitive credential not exposed to the agent..

string

Microsoft 365 OAuth refresh token; security-sensitive credential not exposed to the agent..

string

Zoom OAuth access token; security-sensitive credential not exposed to the agent..

string

Zoom OAuth refresh token; security-sensitive credential not exposed to the agent..

string

External Zoom user ID managed by the calendar integration..

string

Doordeck private key; security-sensitive credential not exposed to the agent..

string

Doordeck public key used by the access integration; not exposed through customer administration..

string

External Doordeck user ID managed by the access integration..

string

Microsoft 365 calendar subscription ID managed by the calendar integration..

string

Salto access-control token; security-sensitive credential not exposed to the agent..

string

Stripe ACH bank token; security-sensitive payment credential not exposed to the agent..

string

Stripe ACH customer token; security-sensitive payment credential not exposed to the agent..

boolean

Internal Stripe ACH agreement status; maintained by the payment flow and not exposed to the agent..

boolean

Internal Stripe ACH deposit-verification status; maintained by the payment flow and not exposed to the agent..

string

Optional purchase-order reference used for this customer’s billing..

boolean

Internal Square synchronization flag; maintained by the integration and not exposed to the agent..

string

Email address for delivery notifications, limited to 254 characters..

boolean

Internal marker that an access-control error notification was sent; not exposed to the agent..

boolean

Internal PaperCut synchronization marker; not exposed to the agent..

string

Google OAuth token; security-sensitive credential not exposed to the agent..

string

Google calendar subscription ID managed by the calendar integration..

string

Read-only comma-separated list of all contract IDs for this customer; derived from contracts and not exposed to the agent..

string

Read-only comma-separated list of plan names for all customer contracts; derived from contracts and not exposed to the agent..

integer

Read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead..

integer

Read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead..

integer

Read-only monthly billing interval of this customer’s main contract; change the contract instead..

integer

Read-only weekly billing interval of this customer’s main contract; change the contract instead..

string

Read-only next invoice date of this customer’s main contract; change the contract instead..

string

Read-only billing team name, populated only when the customer belongs to a merged-billing team with a paying member assigned..

integer

Read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned..

string

Read-only team names derived from team membership; change Teams instead..

string

Read-only team IDs derived from team membership; change Teams instead..

string

Obsolete access signature derived by the access-control system; not exposed to the agent..

string

Internal access signatures derived by the access-control system; not exposed to the agent..

boolean

Whether customer-specific invoice-segregation settings override the location-level settings..

boolean

Whether charges for contracts other than the main contract are invoiced separately from main-contract charges when invoice segregation is enabled..

boolean

Whether booking charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

Whether product charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

Whether pass charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

Whether event-ticket charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

Whether this is the active customer profile when the linked user account has multiple customer profiles..

boolean

Whether one-off charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

integer

External Brivo access-control user ID managed by the integration..

boolean

Internal Ezeep printing synchronization flag; managed by the integration..

number

Read-only predicted probability that this customer will churn, calculated by the analytics process..

string

Read-only engagement classification calculated by the analytics process..

integer

Day of the month used to calculate the customer-specific invoice due date..

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

number

Optional geographic longitude for the contact address..

number

Optional geographic latitude for the contact address..

number

Optional geographic longitude for the billing address..

number

Optional geographic latitude for the billing address..

boolean

Whether this customer is archived..

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