Search Coworkers

GET

api

spaces

coworkers

Search Coworkers

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Enums

eCoworkerRecordType — CoworkerType values

Value	Name
1	Individual
2	Company

eGender — Gender values

Value	Name
0	None
1	NotSet
2	Male
3	Female
4	Other
5	RatherNotSay

eCoworkerTaxRateType — TaxRateType values

Value	Name
1	Default
2	Reduced
3	Exempt

eCoworkerAttendance — MondayAttendance values

Value	Name
1	WorkingFromOffice
2	WorkingFromHome
3	WorkingFromAbroad
4	NotWorking
5	Undefined

eRegularPaymentProvider

Value	Name
0	None
1	MultiGateway
2	Stripe
3	Forte
4	AuthorizeNetSubscription
5	PaypalStandardSubscription
6	PayPalAdaptive
7	EPay
8	Braintree
9	EziDebit
10	LiqPay
11	StripeACH
12	GoCardless
13	StripeBACS
94	CreditNote
95	GiftCard
96	BankTransfer
97	Cash
98	Check
99	Other

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by coworker type.

string

Filter by full name.

string

Filter by title or salutation prefix (e.g. Mr, Mrs, Dr).

integer

Filter by gender of the person.

string

Filter by email address.

boolean

Filter by create user account. Grants portal and app access and sends a welcome email with the access details.

string

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

string

Filter by uRL of a new file to upload as the avatar.

boolean

Filter by set to true to remove the current avatar file.

string

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

string

Filter by uRL of a new file to upload as the banner image.

boolean

Filter by set to true to remove the current banner image file.

string

Filter by street address.

string

Filter by post code.

string

Filter by city name.

string

Filter by state or province.

integer

Filter by iD of the country linked to this record.

integer

Filter by iD of the simple time zone linked to this record.

string

Filter by mobile phone.

string

Filter by land line.

string

Filter by date of birth.

string

Filter by nickname.

string

Filter by business area.

string

Filter by display order position or job title.

string

Filter by company name.

string

Filter by profile website.

string

Filter by profile tags.

string

Filter by profile summary.

string

Filter by twitter handle.

string

Filter by facebook profile.

string

Filter by the google value for this coworker.

string

Filter by telegram handle.

string

Filter by linkedIn profile.

string

Filter by skype handle.

string

Filter by gitHub profile.

string

Filter by the pinterest value for this coworker.

string

Filter by the flickr value for this coworker.

string

Filter by instagram profile.

string

Filter by the vimeo value for this coworker.

string

Filter by the tumblr value for this coworker.

string

Filter by the blogger value for this coworker.

boolean

Filter by profile is public.

integer

Filter by iD of the invoicing business linked to this record.

string

Filter by the name of the customer home location.

string

Filter by billing email.

string

Filter by billing name.

string

Filter by billing address.

string

Filter by billing post code.

string

Filter by billing city.

string

Filter by billing state.

integer

Filter by iD of the billing country linked to this record.

integer

Filter by iD of the billing simple time zone linked to this record.

integer

Filter by tax rate type.

number

Filter by tax rate.

string

Filter by tax ID number.

string

Filter by bank name.

string

Filter by bank account.

string

Filter by bank branch.

boolean

Filter by notify on new invoice.

boolean

Filter by notify on new payment.

boolean

Filter by notify on failed payment.

boolean

Filter by show paying member invoices.

boolean

Filter by enable GoCardless payments.

boolean

Filter by whether use go cardless pro payments is enabled.

string

Filter by goCardless contract number.

string

Filter by iD of the stripe bacs dd payment method associated with this record.

string

Filter by iD of the stripe bacs dd mandate associated with this record.

string

Filter by the stripe bacs dd customer token value for this coworker.

boolean

Filter by whether stripe bacs dd enabled is enabled.

string

Filter by date/time value for last over due invoice reminder.

string

Filter by date/time value for last low credit reminder.

string

Filter by unique identifier (GUID) for the referer.

integer

Filter by regular payment provider.

string

Filter by regular payment contract number.

string

Filter by card number.

boolean

Filter by do not process invoices automatically.

boolean

Filter by allow network check-in.

integer

Filter by check-ins since last renewal.

integer

Filter by minutes since last renewal.

string

Filter by access card ID.

string

Filter by access PIN code.

string

Filter by key fob number.

boolean

Filter by notify on delivery.

string

Filter by iD of the ezeep user associated with this record.

boolean

Filter by whether ezeep free printing is enabled.

string

Filter by iD of the ezeep blue user associated with this record.

boolean

Filter by whether ezeep blue free printing is enabled.

boolean

Filter by whether ezeep blue printing enabled is enabled.

boolean

Filter by whether paper cut pay as you print is enabled.

boolean

Filter by whether paper cut free printing is enabled.

string

Filter by iD of the paper cut user associated with this record.

boolean

Filter by can make bookings.

boolean

Filter by can book for team.

boolean

Filter by can purchase products.

boolean

Filter by can purchase events.

boolean

Filter by can access community.

string

Filter by reference number.

string

Filter by free-form tag for categorising or filtering.

string

Filter by optional notes or comments about this coworker.

boolean

Filter by show alert.

string

Filter by alert note.

integer

Filter by iD of the user linked to this record.

string

Filter by display name of the linked user full (read-only).

boolean

Filter by whether user is admin is enabled.

string

Filter by date/time value for user last access.

boolean

Filter by whether user active is enabled.

boolean

Filter by whether user receive community digest is enabled.

boolean

Filter by whether user receive every message is enabled.

boolean

Filter by whether this coworker is currently active.

string

Filter by next auto invoice date.

integer

Filter by invoice due date period.

string

Filter by registration date.

boolean

Filter by general terms accepted.

string

Filter by date/time value for last renewal.

string

Filter by date/time value for last invoice attempt.

string

Filter by custom field 1.

string

Filter by custom field 2.

string

Filter by custom field 3.

string

Filter by custom field 4.

string

Filter by custom field 5.

string

Filter by custom field 6.

string

Filter by custom field 7.

string

Filter by custom field 8.

string

Filter by custom field 9.

string

Filter by custom field 10.

string

Filter by custom field 11.

string

Filter by custom field 12.

string

Filter by custom field 13.

string

Filter by custom field 14.

string

Filter by custom field 15.

string

Filter by custom field 16.

string

Filter by custom field 17.

string

Filter by custom field 18.

string

Filter by custom field 19.

string

Filter by custom field 20.

string

Filter by custom field 21.

string

Filter by custom field 22.

string

Filter by custom field 23.

string

Filter by custom field 24.

string

Filter by custom field 25.

string

Filter by custom field 26.

string

Filter by custom field 27.

string

Filter by custom field 28.

string

Filter by custom field 29.

string

Filter by custom field 30.

string

Filter by date/time value for next invoice local.

string

Filter by date/time value for next auto invoice local.

string

Filter by date/time value for registration date local.

string

Filter by date/time value for access control debounce time.

string

Filter by the office365 access token value for this coworker.

string

Filter by the office365 refresh token value for this coworker.

string

Filter by the zoom access token value for this coworker.

string

Filter by the zoom refresh token value for this coworker.

string

Filter by iD of the zoom user associated with this record.

string

Filter by the doordeck private key value for this coworker.

string

Filter by the doordeck public key value for this coworker.

string

Filter by unique identifier (GUID) for the doordeck user.

string

Filter by iD of the office365 subscription associated with this record.

string

Filter by the salto v2 access token value for this coworker.

string

Filter by the stripe ach bank token value for this coworker.

string

Filter by the stripe ach customer token value for this coworker.

boolean

Filter by whether has accepted stripe ach agreement is enabled.

boolean

Filter by whether has verified stripe ach deposits is enabled.

string

Filter by purchase order.

boolean

Filter by whether sync to square is enabled.

string

Filter by notify on deliveries email.

boolean

Filter by whether access control error notification sent is enabled.

boolean

Filter by whether sync to paper cut due is enabled.

string

Filter by the google api token value for this coworker.

string

Filter by iD of the google subscription associated with this record.

string

Filter by the coworker contract ids value for this coworker.

string

Filter by the coworker contract tariff names value for this coworker.

integer

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

integer

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

integer

Filter by tariff invoice every N months.

integer

Filter by tariff invoice every N weeks.

string

Filter by renewal date. Used with TariffId as the date when the plan starts and will be invoiced first.

string

Filter by display name of the linked team (read-only).

integer

Filter by iD of the team associated with this record.

string

Filter by team names.

string

Filter by the team ids value for this coworker.

string

Filter by the current access signature value for this coworker.

string

Filter by the current access signatures value for this coworker.

boolean

Filter by whether invoice segregation override is enabled.

boolean

Filter by whether invoice segregate contracts is enabled.

boolean

Filter by whether invoice segregate bookings is enabled.

boolean

Filter by whether invoice segregate products is enabled.

boolean

Filter by whether invoice segregate time passes is enabled.

boolean

Filter by whether invoice segregate tickets is enabled.

boolean

Filter by whether is default profile is enabled.

boolean

Filter by whether invoice segregate charges is enabled.

integer

Filter by iD of the brivo user associated with this record.

boolean

Filter by whether ezeep printing enabled is enabled.

number

Filter by the churn probability value for this coworker.

string

Filter by the engagement level value for this coworker.

integer

Filter by the invoice due date day value for this coworker.

integer

Filter by monday attendance.

integer

Filter by tuesday attendance.

integer

Filter by wednesday attendance.

integer

Filter by thursday attendance.

integer

Filter by friday attendance.

integer

Filter by saturday attendance.

integer

Filter by sunday attendance.

number

Filter by gPS longitude coordinate.

number

Filter by gPS latitude coordinate.

number

Filter by billing longitude.

number

Filter by billing latitude.

boolean

Filter by whether this coworker is archived and hidden from active lists.

Range Filters

string

Filter by date of birth greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date of birth less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by tax rate greater than or equal to this value.

number

Filter by tax rate less than or equal to this value.

string

Filter by date/time value for last over due invoice reminder greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last over due invoice reminder less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last low credit reminder greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last low credit reminder less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by check-ins since last renewal greater than or equal to this value.

integer

Filter by check-ins since last renewal less than or equal to this value.

integer

Filter by minutes since last renewal greater than or equal to this value.

integer

Filter by minutes since last renewal less than or equal to this value.

string

Filter by date/time value for user last access greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for user last access less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by next auto invoice date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by next auto invoice date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by invoice due date period greater than or equal to this value.

integer

Filter by invoice due date period less than or equal to this value.

string

Filter by registration date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by registration date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last renewal greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last renewal less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last invoice attempt greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last invoice attempt less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for next invoice local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for next invoice local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for next auto invoice local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for next auto invoice local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for registration date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for registration date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for access control debounce time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for access control debounce time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by billing day. Used with TariffId to fix the billing day (defaults to current day or the plan’s default billing day) greater than or equal to this value.

integer

Filter by billing day. Used with TariffId to fix the billing day (defaults to current day or the plan’s default billing day) less than or equal to this value.

integer

Filter by plan ID. Creates a new contract for this plan at the same time as the customer. Combine with BillingDay and RenewalDate greater than or equal to this value.

integer

Filter by plan ID. Creates a new contract for this plan at the same time as the customer. Combine with BillingDay and RenewalDate less than or equal to this value.

integer

Filter by tariff invoice every N months greater than or equal to this value.

integer

Filter by tariff invoice every N months less than or equal to this value.

integer

Filter by tariff invoice every N weeks greater than or equal to this value.

integer

Filter by tariff invoice every N weeks less than or equal to this value.

string

Filter by renewal date. Used with TariffId as the date when the plan starts and will be invoiced first greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by renewal date. Used with TariffId as the date when the plan starts and will be invoiced first less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by iD of the team associated with this record greater than or equal to this value.

integer

Filter by iD of the team associated with this record less than or equal to this value.

integer

Filter by iD of the brivo user associated with this record greater than or equal to this value.

integer

Filter by iD of the brivo user associated with this record less than or equal to this value.

number

Filter by the churn probability value for this coworker greater than or equal to this value.

number

Filter by the churn probability value for this coworker less than or equal to this value.

integer

Filter by the invoice due date day value for this coworker greater than or equal to this value.

integer

Filter by the invoice due date day value for this coworker less than or equal to this value.

number

Filter by gPS longitude coordinate greater than or equal to this value.

number

Filter by gPS longitude coordinate less than or equal to this value.

number

Filter by gPS latitude coordinate greater than or equal to this value.

number

Filter by gPS latitude coordinate less than or equal to this value.

number

Filter by billing longitude greater than or equal to this value.

number

Filter by billing longitude less than or equal to this value.

number

Filter by billing latitude greater than or equal to this value.

number

Filter by billing latitude less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkers?page=1&size=15&orderBy=FullName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkers?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'FullName',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkers',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'FullName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by FullName

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkers?Coworker_FullName=example-value&orderBy=FullName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkers?' + new URLSearchParams({
    Coworker_FullName: 'example-value',
    orderBy: 'FullName',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkers',
    params={
        'Coworker_FullName': 'example-value',
        'orderBy': 'FullName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkers?from_Coworker_UpdatedOn=2025-01-01T00:00&to_Coworker_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkers?' + new URLSearchParams({
    from_Coworker_UpdatedOn: '2025-01-01T00:00',
    to_Coworker_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkers',
    params={
        'from_Coworker_UpdatedOn': '2025-01-01T00:00',
        'to_Coworker_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Coworker[]

The list of Coworker records matching the query. See the Get one Coworker endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Coworker. The following fields are not populated in the Records[] response: CoworkerType, Gender, CreateUser, Address, PostCode, CityName, State, MobilePhone, LandLine, NickName, BusinessArea, Position, CompanyName, ProfileWebsite, ProfileTags, ProfileSummary, Twitter, Facebook, Google, Telegram, Linkedin, Skype, Github, Pinterest, Flickr, Instagram, Vimeo, Tumblr, Blogger, ProfileIsPublic, BillingEmail, BillingAddress, BillingPostCode, BillingCityName, BillingState, BillingCountryId, TaxRateType, TaxRate, TaxIDNumber, BankName, BankAccount, BankBranch, NotifyOnNewInvoice, NotifyOnNewPayment, NotifyOnFailedPayment, ShowPayingMemberInvoices, EnableGoCardlessPayments, UseGoCardlessProPayments, GoCardlessContractNumber, StripeBacsDDPaymentMethodId, StripeBacsDDMandateId, StripeBacsDDEnabled, RegularPaymentProvider, RegularPaymentContractNumber, DoNotProcessInvoicesAutomatically, AllowNetworkCheckin, AccessPincode, KeyFobNumber, NotifyOnDelivery, EzeepUserId, EzeepFreePrinting, EzeepBlueUserId, EzeepBlueFreePrinting, EzeepBluePrintingEnabled, PaperCutPayAsYouPrint, PaperCutUserId, Notes, Custom1, Custom2, Custom3, Custom4, Custom5, Custom6, Custom7, Custom8, Custom9, Custom10, Custom11, Custom12, Custom13, Custom14, Custom15, Custom16, Custom17, Custom18, Custom19, Custom20, Custom21, Custom22, Custom23, Custom24, Custom25, Custom26, Custom27, Custom28, Custom29, Custom30, PurchaseOrder, NotifyOnDeliveriesEmail, AccessControlErrorNotificationSent, SyncToPaperCutDue, InvoiceSegregationOverride, InvoiceSegregateContracts, InvoiceSegregateBookings, InvoiceSegregateProducts, InvoiceSegregateTimePasses, InvoiceSegregateTickets, IsDefaultProfile, InvoiceSegregateCharges, EzeepPrintingEnabled, InvoiceDueDateDay.To get all fields, fetch the full record using the Get one Coworker endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "Businesses": [],
      "Teams": [],
      "FullName": "",
      "Salutation": null,
      "Email": "",
      "AvatarFileName": null,
      "NewAvatarUrl": null,
      "ClearAvatarFile": null,
      "BannerImageFileName": null,
      "NewBannerImageUrl": null,
      "ClearBannerImageFile": null,
      "CountryId": 0,
      "SimpleTimeZoneId": 0,
      "DateOfBirth": null,
      "InvoicingBusinessId": null,
      "InvoicingBusinessName": null,
      "BillingName": null,
      "BillingSimpleTimeZoneId": null,
      "StripeBacsDDCustomerToken": null,
      "LastOverDueInvoiceReminder": null,
      "LastLowCreditReminder": null,
      "RefererGuid": null,
      "CardNumber": null,
      "CheckinSinceLastRenewal": 0,
      "MinutesSinceLastRenewal": 0,
      "AccessCardId": null,
      "PaperCutFreePrinting": false,
      "CanMakeBookings": false,
      "CanBookForTeam": false,
      "CanPurchaseProducts": false,
      "CanPurchaseEvents": false,
      "CanAccessCommunity": false,
      "ReferenceNumber": null,
      "Tag": 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,
      "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,
      "SyncToSquare": 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,
      "BrivoUserId": null,
      "ChurnProbability": null,
      "EngagementLevel": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "FullName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CoworkerRetrieve a single Coworker record by its Id.

Search Coworkers

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by FullName

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by FullName

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by FullName

Range filters

Response

200