> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search Coworkers > Search and list Coworker records with filtering, sorting, and pagination. 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 | Value | Name | | ----- | ---------- | | 1 | Individual | | 2 | Company | | Value | Name | | ----- | ------------ | | 0 | None | | 1 | NotSet | | 2 | Male | | 3 | Female | | 4 | Other | | 5 | RatherNotSay | | Value | Name | | ----- | ------- | | 1 | Default | | 2 | Reduced | | 3 | Exempt | | Value | Name | | ----- | ----------------- | | 1 | WorkingFromOffice | | 2 | WorkingFromHome | | 3 | WorkingFromAbroad | | 4 | NotWorking | | 5 | Undefined | | 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 The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by coworker type. Filter by full name. Filter by salutation. Filter by gender. Filter by email address. Filter by create user account. Grants portal and app access and sends a welcome email with the access details. Filter by Avatar File Name. Filter by New Avatar Url. Filter by Clear Avatar File. Filter by Banner Image File Name. Filter by New Banner Image Url. Filter by Clear Banner Image File. Filter by address. Filter by post code. Filter by city name. Filter by state. Filter by Country Id. Filter by Simple Time Zone Id. Filter by mobile phone. Filter by land line. Filter by date of birth. Filter by nickname. Filter by business area. Filter by position. Filter by company name. Filter by profile website. Filter by profile tags. Filter by profile summary. Filter by twitter handle. Filter by facebook profile. Filter by Google. Filter by telegram handle. Filter by linkedIn profile. Filter by skype handle. Filter by gitHub profile. Filter by Pinterest. Filter by Flickr. Filter by instagram profile. Filter by Vimeo. Filter by Tumblr. Filter by Blogger. Filter by profile is public. Filter by Invoicing Business Id. Filter by the name of the customer home location. Filter by billing email. Filter by billing name. Filter by billing address. Filter by billing post code. Filter by billing city. Filter by billing state. Filter by Billing Country Id. Filter by Billing Simple Time Zone Id. Filter by tax rate type. Filter by tax rate. Filter by tax ID number. Filter by bank name. Filter by bank account. Filter by bank branch. Filter by notify on new invoice. Filter by notify on new payment. Filter by notify on failed payment. Filter by show paying member invoices. Filter by enable GoCardless payments. Filter by Use Go Cardless Pro Payments. Filter by goCardless contract number. Filter by Stripe Bacs DDPayment Method Id. Filter by Stripe Bacs DDMandate Id. Filter by Stripe Bacs DDCustomer Token. Filter by Stripe Bacs DDEnabled. Filter by Last Over Due Invoice Reminder. Filter by Last Low Credit Reminder. Filter by Referer Guid. Filter by regular payment provider. Filter by regular payment contract number. Filter by card number. Filter by do not process invoices automatically. Filter by allow network check-in. Filter by check-ins since last renewal. Filter by minutes since last renewal. Filter by access card ID. Filter by access PIN code. Filter by key fob number. Filter by notify on delivery. Filter by Ezeep User Id. Filter by Ezeep Free Printing. Filter by Ezeep Blue User Id. Filter by Ezeep Blue Free Printing. Filter by Ezeep Blue Printing Enabled. Filter by Paper Cut Pay As You Print. Filter by Paper Cut Free Printing. Filter by Paper Cut User Id. Filter by can make bookings. Filter by can book for team. Filter by can purchase products. Filter by can purchase events. Filter by can access community. Filter by reference number. Filter by tag. Filter by notes. Filter by show alert. Filter by alert note. Filter by User Id. Filter by User Full Name. Filter by User Is Admin. Filter by User Last Access. Filter by User Active. Filter by User Receive Community Digest. Filter by User Receive Every Message. Filter by active. Filter by next auto invoice date. Filter by invoice due date period. Filter by registration date. Filter by general terms accepted. Filter by Last Renewal. Filter by Last Invoice Attempt. Filter by custom field 1. Filter by custom field 2. Filter by custom field 3. Filter by custom field 4. Filter by custom field 5. Filter by custom field 6. Filter by custom field 7. Filter by custom field 8. Filter by custom field 9. Filter by custom field 10. Filter by custom field 11. Filter by custom field 12. Filter by custom field 13. Filter by custom field 14. Filter by custom field 15. Filter by custom field 16. Filter by custom field 17. Filter by custom field 18. Filter by custom field 19. Filter by custom field 20. Filter by custom field 21. Filter by custom field 22. Filter by custom field 23. Filter by custom field 24. Filter by custom field 25. Filter by custom field 26. Filter by custom field 27. Filter by custom field 28. Filter by custom field 29. Filter by custom field 30. Filter by Next Invoice Local. Filter by Next Auto Invoice Local. Filter by Registration Date Local. Filter by Access Control Debounce Time. Filter by Office365Access Token. Filter by Office365Refresh Token. Filter by Zoom Access Token. Filter by Zoom Refresh Token. Filter by Zoom User Id. Filter by Doordeck Private Key. Filter by Doordeck Public Key. Filter by Doordeck User Guid. Filter by Office365Subscription Id. Filter by Salto V2Access Token. Filter by Stripe ACHBank Token. Filter by Stripe ACHCustomer Token. Filter by Has Accepted Stripe ACHAgreement. Filter by Has Verified Stripe ACHDeposits. Filter by purchase order. Filter by Sync To Square. Filter by notify on deliveries email. Filter by Access Control Error Notification Sent. Filter by Sync To Paper Cut Due. Filter by Google Api Token. Filter by Google Subscription Id. Filter by Coworker Contract Ids. Filter by Coworker Contract Tariff Names. Filter by billing day. Used with `TariffId` to fix the billing day (defaults to current day or the plan's default billing day). Filter by plan ID. Creates a new contract for this plan at the same time as the customer. Combine with `BillingDay` and `RenewalDate`. Filter by tariff invoice every N months. Filter by tariff invoice every N weeks. Filter by renewal date. Used with `TariffId` as the date when the plan starts and will be invoiced first. Filter by Team Name. Filter by Team Id. Filter by team names. Filter by Team Ids. Filter by Current Access Signature. Filter by Current Access Signatures. Filter by Invoice Segregation Override. Filter by Invoice Segregate Contracts. Filter by Invoice Segregate Bookings. Filter by Invoice Segregate Products. Filter by Invoice Segregate Time Passes. Filter by Invoice Segregate Tickets. Filter by Is Default Profile. Filter by Invoice Segregate Charges. Filter by Brivo User Id. Filter by Ezeep Printing Enabled. Filter by Churn Probability. Filter by Engagement Level. Filter by Invoice Due Date Day. Filter by monday attendance. Filter by tuesday attendance. Filter by wednesday attendance. Filter by thursday attendance. Filter by friday attendance. Filter by saturday attendance. Filter by sunday attendance. Filter by longitude. Filter by latitude. Filter by billing longitude. Filter by billing latitude. Filter by archived. ### Range Filters Filter by date of birth greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date of birth less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by tax rate greater than or equal to this value. Filter by tax rate less than or equal to this value. Filter by last over due invoice reminder greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last over due invoice reminder less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last low credit reminder greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last low credit reminder less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by check-ins since last renewal greater than or equal to this value. Filter by check-ins since last renewal less than or equal to this value. Filter by minutes since last renewal greater than or equal to this value. Filter by minutes since last renewal less than or equal to this value. Filter by user last access greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by user last access less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next auto invoice date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next auto invoice date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoice due date period greater than or equal to this value. Filter by invoice due date period less than or equal to this value. Filter by registration date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by registration date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last renewal greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last renewal less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last invoice attempt greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last invoice attempt less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next invoice local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next invoice local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next auto invoice local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by next auto invoice local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by registration date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by registration date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by access control debounce time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by access control debounce time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. 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. 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. 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. 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. Filter by tariff invoice every N months greater than or equal to this value. Filter by tariff invoice every N months less than or equal to this value. Filter by tariff invoice every N weeks greater than or equal to this value. Filter by tariff invoice every N weeks less than or equal to this value. 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`. 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`. Filter by team id greater than or equal to this value. Filter by team id less than or equal to this value. Filter by brivo user id greater than or equal to this value. Filter by brivo user id less than or equal to this value. Filter by churn probability greater than or equal to this value. Filter by churn probability less than or equal to this value. Filter by invoice due date day greater than or equal to this value. Filter by invoice due date day less than or equal to this value. Filter by longitude greater than or equal to this value. Filter by longitude less than or equal to this value. Filter by latitude greater than or equal to this value. Filter by latitude less than or equal to this value. Filter by billing longitude greater than or equal to this value. Filter by billing longitude less than or equal to this value. Filter by billing latitude greater than or equal to this value. Filter by billing latitude less than or equal to this value. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/coworkers?page=1&size=15&orderBy=FullName&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/coworkers?Coworker_FullName=example-value&orderBy=FullName&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} 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" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 The list of Coworker records matching the query. See the [Get one Coworker](/rest-api/spaces/get-coworkers-by-id) 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](/rest-api/spaces/get-coworkers-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "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 } ```