Search Coworkers

GET

api

spaces

coworkers

Search Coworkers

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

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

Enums

eCoworkerRecordType — CoworkerType values

Value	Name
1	Individual
2	Company

eGender — Gender values

Value	Name
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
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 whether this customer record represents an Individual or a Company..

string

Filter by customer’s full name; required and limited to 254 characters..

string

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

Filter by optional customer gender: NotSet, Male, Female, Other, or RatherNotSay..

string

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

boolean

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

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 customer contact street address..

string

Filter by customer contact postal or ZIP code, limited to 15 characters..

string

Filter by customer contact city, limited to 50 characters..

string

Filter by customer contact state, province, or region, limited to 255 characters..

integer

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

integer

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

string

Filter by customer mobile telephone number, limited to 255 characters..

string

Filter by customer landline or office telephone number, limited to 255 characters..

string

Filter by optional customer date of birth..

string

Filter by optional informal customer name, limited to 254 characters..

string

Filter by customer’s professional sector or business area, limited to 254 characters..

string

Filter by customer’s job title or role, limited to 254 characters..

string

Filter by customer’s employer or company name..

string

Filter by customer’s profile or company website URL, limited to 254 characters..

string

Filter by customer profile tags as a text value, limited to 254 characters..

string

Filter by customer’s public profile summary or biography, limited to 4,096 characters..

string

Filter by customer’s Twitter profile or handle, limited to 254 characters..

string

Filter by customer’s Facebook profile or handle, limited to 254 characters..

string

Filter by customer’s Google profile or handle, limited to 254 characters..

string

Filter by customer’s Telegram profile or handle, limited to 254 characters..

string

Filter by customer’s LinkedIn profile or handle, limited to 254 characters..

string

Filter by customer’s Skype profile or handle, limited to 254 characters..

string

Filter by customer’s GitHub profile or handle, limited to 254 characters..

string

Filter by customer’s Pinterest profile or handle, limited to 254 characters..

string

Filter by customer’s Flickr profile or handle, limited to 254 characters..

string

Filter by customer’s Instagram profile or handle, limited to 254 characters..

string

Filter by customer’s Vimeo profile or handle, limited to 254 characters..

string

Filter by customer’s Tumblr profile or handle, limited to 254 characters..

string

Filter by customer’s Blogger profile or handle, limited to 254 characters..

boolean

Filter by whether the customer’s profile is visible in the public member directory..

integer

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

Filter by display value for InvoicingBusiness.Name..

string

Filter by email address to receive this customer’s invoices, limited to 254 characters..

string

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

string

Filter by billing street address; when empty, invoices use the contact address..

string

Filter by billing postal or ZIP code; when empty, invoices use the contact postal code..

string

Filter by billing city; when empty, invoices use the contact city..

string

Filter by billing state, province, or region; when empty, invoices use the contact state..

integer

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

integer

Filter by iD of the time zone used for billing details; global reference data..

integer

Filter by tax treatment for this customer: Default, Reduced, or Exempt..

number

Filter by optional non-negative tax percentage override for this customer..

string

Filter by customer tax or VAT identification number, limited to 255 characters..

string

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

string

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

string

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

boolean

Filter by whether to notify the customer when a new invoice is created..

boolean

Filter by whether to notify the customer when a payment is received..

boolean

Filter by whether to notify the customer when an automatic payment fails..

boolean

Filter by whether this customer can view invoices of their paying member when one exists..

boolean

Filter by whether GoCardless regular payments are enabled for this customer..

boolean

Filter by internal GoCardless Pro integration flag; managed by payment integration setup..

string

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

string

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

string

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

string

Filter by stripe BACS customer token; security-sensitive integration credential not exposed to the agent..

boolean

Filter by whether Stripe BACS direct-debit payments are enabled for this customer..

string

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

string

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

string

Filter by internal referral tracking identifier; not exposed to the agent..

integer

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

string

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

string

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

boolean

Filter by whether automatic invoice payment processing is disabled for this customer..

boolean

Filter by whether this customer may check in through the network check-in integration..

integer

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

integer

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

string

Filter by physical access-card identifier; managed through access control and not exposed to the agent..

string

Filter by access-control PIN; security-sensitive and not exposed to the agent..

string

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

boolean

Filter by whether to notify this customer about deliveries for their team..

string

Filter by external Ezeep user ID used by the printing integration..

boolean

Filter by whether this customer can print for free through Ezeep..

string

Filter by external Ezeep Blue user ID used by the printing integration..

boolean

Filter by whether this customer can print for free through Ezeep Blue..

boolean

Filter by internal Ezeep Blue printing synchronization flag; managed by the integration..

boolean

Filter by whether PaperCut pay-as-you-print is enabled for this customer..

boolean

Filter by whether this customer can print for free through PaperCut..

string

Filter by external PaperCut user identifier used by the printing integration..

boolean

Filter by whether this customer may make bookings..

boolean

Filter by whether this customer may make bookings on behalf of their team..

boolean

Filter by whether this customer may purchase products..

boolean

Filter by whether this customer may purchase event tickets..

boolean

Filter by whether this customer may access the community feature..

string

Filter by optional external or internal reference number for this customer..

string

Filter by optional free-text tag used to classify this customer..

string

Filter by internal notes about this customer..

boolean

Filter by whether an alert should be shown when staff open this customer’s record..

string

Filter by alert message displayed to staff when ShowAlert is enabled..

integer

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

string

Filter by display value for User.FullName..

boolean

Filter by display value for User.IsAdmin..

string

Filter by display value for User.LastAccess..

boolean

Filter by display value for User.Active..

boolean

Filter by display value for User.ReceiveCommunityDigest..

boolean

Filter by display value for User.ReceiveEveryMessage..

boolean

Filter by whether this customer record is active..

string

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

integer

Filter by optional number of days after issue date before this customer’s invoices are due..

string

Filter by optional customer registration date..

boolean

Filter by whether the customer has accepted the location’s general terms and conditions..

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

Filter by internal access-control debounce timestamp; not exposed to the agent..

string

Filter by microsoft 365 OAuth access token; security-sensitive credential not exposed to the agent..

string

Filter by microsoft 365 OAuth refresh token; security-sensitive credential not exposed to the agent..

string

Filter by zoom OAuth access token; security-sensitive credential not exposed to the agent..

string

Filter by zoom OAuth refresh token; security-sensitive credential not exposed to the agent..

string

Filter by external Zoom user ID managed by the calendar integration..

string

Filter by doordeck private key; security-sensitive credential not exposed to the agent..

string

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

string

Filter by external Doordeck user ID managed by the access integration..

string

Filter by microsoft 365 calendar subscription ID managed by the calendar integration..

string

Filter by salto access-control token; security-sensitive credential not exposed to the agent..

string

Filter by stripe ACH bank token; security-sensitive payment credential not exposed to the agent..

string

Filter by stripe ACH customer token; security-sensitive payment credential not exposed to the agent..

boolean

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

boolean

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

string

Filter by optional purchase-order reference used for this customer’s billing..

boolean

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

string

Filter by email address for delivery notifications, limited to 254 characters..

boolean

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

boolean

Filter by internal PaperCut synchronization marker; not exposed to the agent..

string

Filter by google OAuth token; security-sensitive credential not exposed to the agent..

string

Filter by google calendar subscription ID managed by the calendar integration..

string

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

string

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

integer

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

integer

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

integer

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

integer

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

string

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

string

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

integer

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

string

Filter by read-only team names derived from team membership; change Teams instead..

string

Filter by read-only team IDs derived from team membership; change Teams instead..

string

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

string

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

boolean

Filter by whether customer-specific invoice-segregation settings override the location-level settings..

boolean

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

boolean

Filter by whether booking charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

Filter by whether product charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

Filter by whether pass charges are invoiced separately from plan and contract charges when invoice segregation is enabled..

boolean

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

boolean

Filter by whether this is the active customer profile when the linked user account has multiple customer profiles..

boolean

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

integer

Filter by external Brivo access-control user ID managed by the integration..

boolean

Filter by internal Ezeep printing synchronization flag; managed by the integration..

number

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

string

Filter by read-only engagement classification calculated by the analytics process..

integer

Filter by day of the month used to calculate the customer-specific invoice due date..

integer

Filter by expected Monday attendance: WorkingFromOffice or WorkingRemotely..

integer

Filter by expected Tuesday attendance: WorkingFromOffice or WorkingRemotely..

integer

Filter by expected Wednesday attendance: WorkingFromOffice or WorkingRemotely..

integer

Filter by expected Thursday attendance: WorkingFromOffice or WorkingRemotely..

integer

Filter by expected Friday attendance: WorkingFromOffice or WorkingRemotely..

integer

Filter by expected Saturday attendance: WorkingFromOffice or WorkingRemotely..

integer

Filter by expected Sunday attendance: WorkingFromOffice or WorkingRemotely..

number

Filter by optional geographic longitude for the contact address..

number

Filter by optional geographic latitude for the contact address..

number

Filter by optional geographic longitude for the billing address..

number

Filter by optional geographic latitude for the billing address..

boolean

Filter by whether this customer is archived..

Range Filters

string

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

string

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

number

Filter by optional non-negative tax percentage override for this customer. greater than or equal to this value.

number

Filter by optional non-negative tax percentage override for this customer. less than or equal to this value.

string

Filter by timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only number of check-ins since the last allowance renewal; maintained from check-in activity. greater than or equal to this value.

integer

Filter by read-only number of check-ins since the last allowance renewal; maintained from check-in activity. less than or equal to this value.

integer

Filter by read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity. greater than or equal to this value.

integer

Filter by read-only number of check-in minutes used since the last allowance renewal; maintained from check-in activity. less than or equal to this value.

string

Filter by display value for User.LastAccess. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for User.LastAccess. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by optional number of days after issue date before this customer’s invoices are due. greater than or equal to this value.

integer

Filter by optional number of days after issue date before this customer’s invoices are due. less than or equal to this value.

string

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

string

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

string

Filter by timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by localized invoice schedule value derived by the application; not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by localized invoice schedule value derived by the application; not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by localized next automatic-invoice value derived by the application; not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by localized next automatic-invoice value derived by the application; not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by localized registration-date value derived by the application; not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by localized registration-date value derived by the application; not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal access-control debounce timestamp; not exposed to the agent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal access-control debounce timestamp; not exposed to the agent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead. greater than or equal to this value.

integer

Filter by read-only billing day of this customer’s main contract; other contracts may have different billing details, so change the contract instead. less than or equal to this value.

integer

Filter by read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead. greater than or equal to this value.

integer

Filter by read-only plan ID of this customer’s main contract; other contracts may use different plans, so change the contract instead. less than or equal to this value.

integer

Filter by read-only monthly billing interval of this customer’s main contract; change the contract instead. greater than or equal to this value.

integer

Filter by read-only monthly billing interval of this customer’s main contract; change the contract instead. less than or equal to this value.

integer

Filter by read-only weekly billing interval of this customer’s main contract; change the contract instead. greater than or equal to this value.

integer

Filter by read-only weekly billing interval of this customer’s main contract; change the contract instead. less than or equal to this value.

string

Filter by read-only next invoice date of this customer’s main contract; change the contract instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only next invoice date of this customer’s main contract; change the contract instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned. greater than or equal to this value.

integer

Filter by read-only billing team ID, populated only when the customer belongs to a merged-billing team with a paying member assigned. less than or equal to this value.

integer

Filter by external Brivo access-control user ID managed by the integration. greater than or equal to this value.

integer

Filter by external Brivo access-control user ID managed by the integration. less than or equal to this value.

number

Filter by read-only predicted probability that this customer will churn, calculated by the analytics process. greater than or equal to this value.

number

Filter by read-only predicted probability that this customer will churn, calculated by the analytics process. less than or equal to this value.

integer

Filter by day of the month used to calculate the customer-specific invoice due date. greater than or equal to this value.

integer

Filter by day of the month used to calculate the customer-specific invoice due date. less than or equal to this value.

number

Filter by optional geographic longitude for the contact address. greater than or equal to this value.

number

Filter by optional geographic longitude for the contact address. less than or equal to this value.

number

Filter by optional geographic latitude for the contact address. greater than or equal to this value.

number

Filter by optional geographic latitude for the contact address. less than or equal to this value.

number

Filter by optional geographic longitude for the billing address. greater than or equal to this value.

number

Filter by optional geographic longitude for the billing address. less than or equal to this value.

number

Filter by optional geographic latitude for the billing address. greater than or equal to this value.

number

Filter by optional geographic latitude for the billing address. 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: Gender, CreateUser, Address, PostCode, CityName, State, MobilePhone, LandLine, NickName, BusinessArea, Position, 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": [
    {
      "CoworkerType": 0,
      "Businesses": [],
      "Teams": [],
      "FullName": "",
      "Salutation": null,
      "Email": "",
      "AvatarFileName": null,
      "NewAvatarUrl": null,
      "ClearAvatarFile": null,
      "BannerImageFileName": null,
      "NewBannerImageUrl": null,
      "ClearBannerImageFile": null,
      "CountryId": 0,
      "SimpleTimeZoneId": 0,
      "DateOfBirth": null,
      "CompanyName": 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
}

Search Coworkers

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

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