Search Coworkers

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 1 for ascending, -1 for descending.

Filters

Coworker_CoworkerType

integer

Filter by coworker type.

Coworker_FullName

string

Filter by full name.

Coworker_Salutation

string

Filter by salutation.

Coworker_Gender

integer

Filter by gender.

Coworker_Email

string

Filter by email address.

Coworker_CreateUser

boolean

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

Coworker_AvatarFileName

string

Filter by Avatar File Name.

Coworker_NewAvatarUrl

string

Filter by New Avatar Url.

Coworker_ClearAvatar

boolean

Filter by Clear Avatar File.

Coworker_BannerImageFileName

string

Filter by Banner Image File Name.

Coworker_NewBannerImageUrl

string

Filter by New Banner Image Url.

Coworker_ClearBannerImage

boolean

Filter by Clear Banner Image File.

Coworker_Address

string

Filter by address.

Coworker_PostCode

string

Filter by post code.

Coworker_CityName

string

Filter by city name.

Coworker_State

string

Filter by state.

Coworker_Country

integer

Filter by Country Id.

Coworker_SimpleTimeZone

integer

Filter by Simple Time Zone Id.

Coworker_MobilePhone

string

Filter by mobile phone.

Coworker_LandLine

string

Filter by land line.

Coworker_DateOfBirth

string

Filter by date of birth.

Coworker_NickName

string

Filter by nickname.

Coworker_BusinessArea

string

Filter by business area.

Coworker_Position

string

Filter by position.

Coworker_CompanyName

string

Filter by company name.

Coworker_ProfileWebsite

string

Filter by profile website.

Coworker_ProfileTags

string

Filter by profile tags.

Coworker_ProfileSummary

string

Filter by profile summary.

Coworker_Twitter

string

Filter by twitter handle.

Coworker_Facebook

string

Filter by facebook profile.

Coworker_Google

string

Filter by Google.

Coworker_Telegram

string

Filter by telegram handle.

Coworker_Linkedin

string

Filter by linkedIn profile.

Coworker_Skype

string

Filter by skype handle.

Coworker_Github

string

Filter by gitHub profile.

Coworker_Pinterest

string

Filter by Pinterest.

Coworker_Flickr

string

Filter by Flickr.

Coworker_Instagram

string

Filter by instagram profile.

Coworker_Vimeo

string

Filter by Vimeo.

Coworker_Tumblr

string

Filter by Tumblr.

Coworker_Blogger

string

Filter by Blogger.

Coworker_ProfileIsPublic

boolean

Filter by profile is public.

Coworker_InvoicingBusiness

integer

Filter by Invoicing Business Id.

Coworker_InvoicingBusiness_Name

string

Filter by the name of the customer home location.

Coworker_BillingEmail

string

Filter by billing email.

Coworker_BillingName

string

Filter by billing name.

Coworker_BillingAddress

string

Filter by billing address.

Coworker_BillingPostCode

string

Filter by billing post code.

Coworker_BillingCityName

string

Filter by billing city.

Coworker_BillingState

string

Filter by billing state.

Coworker_BillingCountry

integer

Filter by Billing Country Id.

Coworker_BillingSimpleTimeZone

integer

Filter by Billing Simple Time Zone Id.

Coworker_TaxRateType

integer

Filter by tax rate type.

Coworker_TaxRate

number

Filter by tax rate.

Coworker_TaxIDNumber

string

Filter by tax ID number.

Coworker_BankName

string

Filter by bank name.

Coworker_BankAccount

string

Filter by bank account.

Coworker_BankBranch

string

Filter by bank branch.

Coworker_NotifyOnNewInvoice

boolean

Filter by notify on new invoice.

Coworker_NotifyOnNewPayment

boolean

Filter by notify on new payment.

Coworker_NotifyOnFailedPayment

boolean

Filter by notify on failed payment.

Coworker_ShowPayingMemberInvoices

boolean

Filter by show paying member invoices.

Coworker_EnableGoCardlessPayments

boolean

Filter by enable GoCardless payments.

Coworker_UseGoCardlessProPayments

boolean

Filter by Use Go Cardless Pro Payments.

Coworker_GoCardlessContractNumber

string

Filter by goCardless contract number.

Coworker_StripeBacsDDPaymentMethodId

string

Filter by Stripe Bacs DDPayment Method Id.

Coworker_StripeBacsDDMandateId

string

Filter by Stripe Bacs DDMandate Id.

Coworker_StripeBacsDDCustomerToken

string

Filter by Stripe Bacs DDCustomer Token.

Coworker_StripeBacsDDEnabled

boolean

Filter by Stripe Bacs DDEnabled.

Coworker_LastOverDueInvoiceReminder

string

Filter by Last Over Due Invoice Reminder.

Coworker_LastLowCreditReminder

string

Filter by Last Low Credit Reminder.

Coworker_RefererGuid

string

Filter by Referer Guid.

Coworker_RegularPaymentProvider

integer

Filter by regular payment provider.

Coworker_RegularPaymentContractNumber

string

Filter by regular payment contract number.

Coworker_CardNumber

string

Filter by card number.

Coworker_DoNotProcessInvoicesAutomatically

boolean

Filter by do not process invoices automatically.

Coworker_AllowNetworkCheckin

boolean

Filter by allow network check-in.

Coworker_CheckinSinceLastRenewal

integer

Filter by check-ins since last renewal.

Coworker_MinutesSinceLastRenewal

integer

Filter by minutes since last renewal.

Coworker_AccessCardId

string

Filter by access card ID.

Coworker_AccessPincode

string

Filter by access PIN code.

Coworker_KeyFobNumber

string

Filter by key fob number.

Coworker_NotifyOnDelivery

boolean

Filter by notify on delivery.

Coworker_EzeepUserId

string

Filter by Ezeep User Id.

Coworker_EzeepFreePrinting

boolean

Filter by Ezeep Free Printing.

Coworker_EzeepBlueUserId

string

Filter by Ezeep Blue User Id.

Coworker_EzeepBlueFreePrinting

boolean

Filter by Ezeep Blue Free Printing.

Coworker_EzeepBluePrintingEnabled

boolean

Filter by Ezeep Blue Printing Enabled.

Coworker_PaperCutPayAsYouPrint

boolean

Filter by Paper Cut Pay As You Print.

Coworker_PaperCutFreePrinting

boolean

Filter by Paper Cut Free Printing.

Coworker_PaperCutUserId

string

Filter by Paper Cut User Id.

Coworker_CanMakeBookings

boolean

Filter by can make bookings.

Coworker_CanBookForTeam

boolean

Filter by can book for team.

Coworker_CanPurchaseProducts

boolean

Filter by can purchase products.

Coworker_CanPurchaseEvents

boolean

Filter by can purchase events.

Coworker_CanAccessCommunity

boolean

Filter by can access community.

Coworker_ReferenceNumber

string

Filter by reference number.

Coworker_Tag

string

Filter by tag.

Coworker_Notes

string

Filter by notes.

Coworker_ShowAlert

boolean

Filter by show alert.

Coworker_AlertNote

string

Filter by alert note.

Coworker_User

integer

Filter by User Id.

Coworker_User_FullName

string

Filter by User Full Name.

Coworker_User_IsAdmin

boolean

Filter by User Is Admin.

Coworker_User_LastAccess

string

Filter by User Last Access.

Coworker_User_Active

boolean

Filter by User Active.

Coworker_User_ReceiveCommunityDigest

boolean

Filter by User Receive Community Digest.

Coworker_User_ReceiveEveryMessage

boolean

Filter by User Receive Every Message.

Coworker_Active

boolean

Filter by active.

Coworker_NextAutoInvoice

string

Filter by next auto invoice date.

Coworker_InvoiceDueDatePeriod

integer

Filter by invoice due date period.

Coworker_RegistrationDate

string

Filter by registration date.

Coworker_GeneralTermsAccepted

boolean

Filter by general terms accepted.

Coworker_LastRenewal

string

Filter by Last Renewal.

Coworker_LastInvoiceAttempt

string

Filter by Last Invoice Attempt.

Coworker_Custom1

string

Filter by custom field 1.

Coworker_Custom2

string

Filter by custom field 2.

Coworker_Custom3

string

Filter by custom field 3.

Coworker_Custom4

string

Filter by custom field 4.

Coworker_Custom5

string

Filter by custom field 5.

Coworker_Custom6

string

Filter by custom field 6.

Coworker_Custom7

string

Filter by custom field 7.

Coworker_Custom8

string

Filter by custom field 8.

Coworker_Custom9

string

Filter by custom field 9.

Coworker_Custom10

string

Filter by custom field 10.

Coworker_Custom11

string

Filter by custom field 11.

Coworker_Custom12

string

Filter by custom field 12.

Coworker_Custom13

string

Filter by custom field 13.

Coworker_Custom14

string

Filter by custom field 14.

Coworker_Custom15

string

Filter by custom field 15.

Coworker_Custom16

string

Filter by custom field 16.

Coworker_Custom17

string

Filter by custom field 17.

Coworker_Custom18

string

Filter by custom field 18.

Coworker_Custom19

string

Filter by custom field 19.

Coworker_Custom20

string

Filter by custom field 20.

Coworker_Custom21

string

Filter by custom field 21.

Coworker_Custom22

string

Filter by custom field 22.

Coworker_Custom23

string

Filter by custom field 23.

Coworker_Custom24

string

Filter by custom field 24.

Coworker_Custom25

string

Filter by custom field 25.

Coworker_Custom26

string

Filter by custom field 26.

Coworker_Custom27

string

Filter by custom field 27.

Coworker_Custom28

string

Filter by custom field 28.

Coworker_Custom29

string

Filter by custom field 29.

Coworker_Custom30

string

Filter by custom field 30.

Coworker_NextInvoiceLocal

string

Filter by Next Invoice Local.

Coworker_NextAutoInvoiceLocal

string

Filter by Next Auto Invoice Local.

Coworker_RegistrationDateLocal

string

Filter by Registration Date Local.

Coworker_AccessControlDebounceTime

string

Filter by Access Control Debounce Time.

Coworker_Office365AccessToken

string

Filter by Office365Access Token.

Coworker_Office365RefreshToken

string

Filter by Office365Refresh Token.

Coworker_ZoomAccessToken

string

Filter by Zoom Access Token.

Coworker_ZoomRefreshToken

string

Filter by Zoom Refresh Token.

Coworker_ZoomUserId

string

Filter by Zoom User Id.

Coworker_DoordeckPrivateKey

string

Filter by Doordeck Private Key.

Coworker_DoordeckPublicKey

string

Filter by Doordeck Public Key.

Coworker_DoordeckUserGuid

string

Filter by Doordeck User Guid.

Coworker_Office365SubscriptionId

string

Filter by Office365Subscription Id.

Coworker_SaltoV2AccessToken

string

Filter by Salto V2Access Token.

Coworker_StripeACHBankToken

string

Filter by Stripe ACHBank Token.

Coworker_StripeACHCustomerToken

string

Filter by Stripe ACHCustomer Token.

Coworker_HasAcceptedStripeACHAgreement

boolean

Filter by Has Accepted Stripe ACHAgreement.

Coworker_HasVerifiedStripeACHDeposits

boolean

Filter by Has Verified Stripe ACHDeposits.

Coworker_PurchaseOrder

string

Filter by purchase order.

Coworker_SyncToSquare

boolean

Filter by Sync To Square.

Coworker_NotifyOnDeliveriesEmail

string

Filter by notify on deliveries email.

Coworker_AccessControlErrorNotificationSent

boolean

Filter by Access Control Error Notification Sent.

Coworker_SyncToPaperCutDue

boolean

Filter by Sync To Paper Cut Due.

Coworker_GoogleApiToken

string

Filter by Google Api Token.

Coworker_GoogleSubscriptionId

string

Filter by Google Subscription Id.

Coworker_CoworkerContractIds

string

Filter by Coworker Contract Ids.

Coworker_CoworkerContractTariffNames

string

Filter by Coworker Contract Tariff Names.

Coworker_BillingDay

integer

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

Coworker_TariffId

integer

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

Coworker_TariffInvoiceEvery

integer

Filter by tariff invoice every N months.

Coworker_TariffInvoiceEveryWeeks

integer

Filter by tariff invoice every N weeks.

Coworker_RenewalDate

string

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

Coworker_TeamName

string

Filter by Team Name.

Coworker_TeamId

integer

Filter by Team Id.

Coworker_TeamNames

string

Filter by team names.

Coworker_TeamIds

string

Filter by Team Ids.

Coworker_CurrentAccessSignature

string

Filter by Current Access Signature.

Coworker_CurrentAccessSignatures

string

Filter by Current Access Signatures.

Coworker_InvoiceSegregationOverride

boolean

Filter by Invoice Segregation Override.

Coworker_InvoiceSegregateContracts

boolean

Filter by Invoice Segregate Contracts.

Coworker_InvoiceSegregateBookings

boolean

Filter by Invoice Segregate Bookings.

Coworker_InvoiceSegregateProducts

boolean

Filter by Invoice Segregate Products.

Coworker_InvoiceSegregateTimePasses

boolean

Filter by Invoice Segregate Time Passes.

Coworker_InvoiceSegregateTickets

boolean

Filter by Invoice Segregate Tickets.

Coworker_IsDefaultProfile

boolean

Filter by Is Default Profile.

Coworker_InvoiceSegregateCharges

boolean

Filter by Invoice Segregate Charges.

Coworker_BrivoUserId

integer

Filter by Brivo User Id.

Coworker_EzeepPrintingEnabled

boolean

Filter by Ezeep Printing Enabled.

Coworker_ChurnProbability

number

Filter by Churn Probability.

Coworker_EngagementLevel

string

Filter by Engagement Level.

Coworker_InvoiceDueDateDay

integer

Filter by Invoice Due Date Day.

Coworker_MondayAttendance

integer

Filter by monday attendance.

Coworker_TuesdayAttendance

integer

Filter by tuesday attendance.

Coworker_WednesdayAttendance

integer

Filter by wednesday attendance.

Coworker_ThursdayAttendance

integer

Filter by thursday attendance.

Coworker_FridayAttendance

integer

Filter by friday attendance.

Coworker_SaturdayAttendance

integer

Filter by saturday attendance.

Coworker_SundayAttendance

integer

Filter by sunday attendance.

Coworker_Longitude

number

Filter by longitude.

Coworker_Latitude

number

Filter by latitude.

Coworker_BillingLongitude

number

Filter by billing longitude.

Coworker_BillingLatitude

number

Filter by billing latitude.

Coworker_Archived

boolean

Filter by archived.

Range Filters

from_Coworker_DateOfBirth

string

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

to_Coworker_DateOfBirth

string

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

from_Coworker_TaxRate

number

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

to_Coworker_TaxRate

number

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

from_Coworker_LastOverDueInvoiceReminder

string

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

to_Coworker_LastOverDueInvoiceReminder

string

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

from_Coworker_LastLowCreditReminder

string

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

to_Coworker_LastLowCreditReminder

string

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

from_Coworker_CheckinSinceLastRenewal

integer

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

to_Coworker_CheckinSinceLastRenewal

integer

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

from_Coworker_MinutesSinceLastRenewal

integer

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

to_Coworker_MinutesSinceLastRenewal

integer

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

from_Coworker_UserLastAccess

string

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

to_Coworker_UserLastAccess

string

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

from_Coworker_NextAutoInvoice

string

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

to_Coworker_NextAutoInvoice

string

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

from_Coworker_InvoiceDueDatePeriod

integer

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

to_Coworker_InvoiceDueDatePeriod

integer

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

from_Coworker_RegistrationDate

string

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

to_Coworker_RegistrationDate

string

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

from_Coworker_LastRenewal

string

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

to_Coworker_LastRenewal

string

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

from_Coworker_LastInvoiceAttempt

string

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

to_Coworker_LastInvoiceAttempt

string

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

from_Coworker_NextInvoiceLocal

string

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

to_Coworker_NextInvoiceLocal

string

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

from_Coworker_NextAutoInvoiceLocal

string

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

to_Coworker_NextAutoInvoiceLocal

string

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

from_Coworker_RegistrationDateLocal

string

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

to_Coworker_RegistrationDateLocal

string

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

from_Coworker_AccessControlDebounceTime

string

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

to_Coworker_AccessControlDebounceTime

string

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

from_Coworker_BillingDay

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.

to_Coworker_BillingDay

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.

from_Coworker_TariffId

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.

to_Coworker_TariffId

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.

from_Coworker_TariffInvoiceEvery

integer

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

to_Coworker_TariffInvoiceEvery

integer

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

from_Coworker_TariffInvoiceEveryWeeks

integer

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

to_Coworker_TariffInvoiceEveryWeeks

integer

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

from_Coworker_RenewalDate

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.

to_Coworker_RenewalDate

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.

from_Coworker_TeamId

integer

Filter by team id greater than or equal to this value.

to_Coworker_TeamId

integer

Filter by team id less than or equal to this value.

from_Coworker_BrivoUserId

integer

Filter by brivo user id greater than or equal to this value.

to_Coworker_BrivoUserId

integer

Filter by brivo user id less than or equal to this value.

from_Coworker_ChurnProbability

number

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

to_Coworker_ChurnProbability

number

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

from_Coworker_InvoiceDueDateDay

integer

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

to_Coworker_InvoiceDueDateDay

integer

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

from_Coworker_Longitude

number

Filter by longitude greater than or equal to this value.

to_Coworker_Longitude

number

Filter by longitude less than or equal to this value.

from_Coworker_Latitude

number

Filter by latitude greater than or equal to this value.

to_Coworker_Latitude

number

Filter by latitude less than or equal to this value.

from_Coworker_BillingLongitude

number

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

to_Coworker_BillingLongitude

number

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

from_Coworker_BillingLatitude

number

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

to_Coworker_BillingLatitude

number

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

from_Coworker_CreatedOn

string

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

to_Coworker_CreatedOn

string

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

from_Coworker_UpdatedOn

string

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

to_Coworker_UpdatedOn

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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by FullName

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

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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

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

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "FullName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​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