Search Users - Nexudus Platform

A User represents an administrator or staff member who can sign in to the Nexudus admin panel. Users are assigned roles that control their permissions and can be associated with one or more business locations.

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

Enums

eLanguage — Language values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

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. 0 for ascending, 1 for descending.

Filters

User_FullName

string

Filter by the full name value for this user.

User_Email

string

Filter by the email value for this user.

User_AccessToken

string

Filter by the access token value for this user.

User_Language

integer

Filter by the language value for this user.

User_PreferredLanguage

integer

Filter by iD of the preferred language linked to this record.

User_NewPassword

string

Filter by the new password value for this user.

User_Password

string

Filter by the password value for this user.

User_PasswordSalt

string

Filter by the password salt value for this user.

User_AvatarFileName

string

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

User_NewAvatarUrl

string

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

User_ClearAvatar

boolean

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

User_Application

integer

Filter by iD of the application linked to this record.

User_PassportNumber

string

Filter by the passport number value for this user.

User_PassportCardNumber

string

Filter by the passport card number value for this user.

User_EnablePassportAccess

boolean

Filter by whether enable passport access is enabled.

User_Active

boolean

Filter by whether this user is currently active.

User_IsAdmin

boolean

Filter by whether is admin is enabled.

User_APIAccess

boolean

Filter by whether api access is enabled.

User_Validated

boolean

Filter by whether validated is enabled.

User_MustResetPassword

boolean

Filter by whether must reset password is enabled.

User_LastAccess

string

Filter by date/time value for last access.

User_Devices

string

Filter by the devices value for this user.

User_OnNewEmail

boolean

Filter by whether on new email is enabled.

User_OnHelpDeskMsg

boolean

Filter by whether on help desk msg is enabled.

User_OnNewWallPost

boolean

Filter by whether on new wall post is enabled.

User_OnNewMember

boolean

Filter by whether on new member is enabled.

User_OnProfileChanges

boolean

Filter by whether on profile changes is enabled.

User_OnNewBlogComment

boolean

Filter by whether on new blog comment is enabled.

User_OnNewEventComment

boolean

Filter by whether on new event comment is enabled.

User_OnTariffChange

boolean

Filter by whether on tariff change is enabled.

User_OnBookingChange

boolean

Filter by whether on booking change is enabled.

User_OnTentativeBookingChange

boolean

Filter by whether on tentative booking change is enabled.

User_OnPurchases

boolean

Filter by whether on purchases is enabled.

User_OnVisitorRegistration

boolean

Filter by whether on visitor registration is enabled.

User_OnPlaformInvoices

boolean

Filter by whether on plaform invoices is enabled.

User_ReceiveCommunityDigest

boolean

Filter by whether receive community digest is enabled.

User_ReceiveEveryMessage

boolean

Filter by whether receive every message is enabled.

User_TwoFactorEnabled

boolean

Filter by whether two factor enabled is enabled.

User_TwoFactorSecret

string

Filter by the two factor secret value for this user.

User_EmailCallBackGuid

string

Filter by unique identifier (GUID) for the email call back.

User_DefaultBusiness

integer

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

User_LastHelpVisited

integer

Filter by the last help visited value for this user.

User_LastReceivedCommunityThreadDate

string

Filter by date/time value for last received community thread date.

User_LastReceivedCommunityMessageDate

string

Filter by date/time value for last received community message date.

User_NextCommunityDigest

string

Filter by date/time value for next community digest.

User_SupportTeamUserEmail

string

Filter by the support team user email value for this user.

Filter by the invalid login attempts value for this user.

Filter by date/time value for last login attempt.

User_OnAccessControlErrors

boolean

Filter by whether on access control errors is enabled.

User_NextHelpDeskMessageReminder

string

Filter by date/time value for next help desk message reminder.

User_OnMemberRemovedFromTeam

boolean

Filter by whether on member removed from team is enabled.

User_OnVirtualOfficeTariffChange

boolean

Filter by whether on virtual office tariff change is enabled.

User_OnVirtualOfficeDeliveryPreferenceUpdate

boolean

Filter by whether on virtual office delivery preference update is enabled.

User_OnIdentityCheckUpdate

boolean

Filter by whether on identity check update is enabled.

Range Filters

from_User_LastAccess

string

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

to_User_LastAccess

string

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

from_User_LastHelpVisited

integer

Filter by the last help visited value for this user greater than or equal to this value.

to_User_LastHelpVisited

integer

Filter by the last help visited value for this user less than or equal to this value.

from_User_LastReceivedCommunityThreadDate

string

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

to_User_LastReceivedCommunityThreadDate

string

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

from_User_LastReceivedCommunityMessageDate

string

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

to_User_LastReceivedCommunityMessageDate

string

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

from_User_NextCommunityDigest

string

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

to_User_NextCommunityDigest

string

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

Filter by the invalid login attempts value for this user greater than or equal to this value.

Filter by the invalid login attempts value for this user less than or equal to this value.

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

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

from_User_NextHelpDeskMessageReminder

string

Filter by date/time value for next help desk message reminder greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_User_NextHelpDeskMessageReminder

string

Filter by date/time value for next help desk message reminder less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_User_CreatedOn

string

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

to_User_CreatedOn

string

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

from_User_UpdatedOn

string

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

to_User_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/sys/users?page=1&size=15&orderBy=FullName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by FullName

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

Range filters

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

Response

200

Records

User[]

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

Partial records — The listing endpoint returns a summary representation of each User. The following fields are not populated in the Records[] response: NewPassword, IsAdmin, APIAccess, MustResetPassword, LastAccess, Devices, OnNewEmail, OnHelpDeskMsg, OnNewWallPost, OnNewMember, OnProfileChanges, OnNewBlogComment, OnNewEventComment, OnTariffChange, OnBookingChange, OnTentativeBookingChange, OnPurchases, OnVisitorRegistration, OnPlaformInvoices, ReceiveCommunityDigest, ReceiveEveryMessage, TwoFactorSecret, LastHelpVisited, OnAccessControlErrors, OnMemberRemovedFromTeam, OnVirtualOfficeTariffChange, OnVirtualOfficeDeliveryPreferenceUpdate, OnIdentityCheckUpdate.To get all fields, fetch the full record using the Get one User 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 (0 = 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": [
    {
      "FullName": "",
      "Email": "",
      "AccessToken": null,
      "Language": 0,
      "PreferredLanguageId": null,
      "Password": null,
      "PasswordSalt": "",
      "AvatarFileName": null,
      "NewAvatarUrl": null,
      "ClearAvatarFile": null,
      "ApplicationId": null,
      "PassportNumber": null,
      "PassportCardNumber": null,
      "EnablePassportAccess": false,
      "Active": false,
      "Validated": false,
      "TwoFactorEnabled": false,
      "EmailCallBackGuid": null,
      "Businesses": [],
      "UserRoles": [],
      "ChatRooms": [],
      "DefaultBusinessId": null,
      "LastReceivedCommunityThreadDate": null,
      "LastReceivedCommunityMessageDate": null,
      "NextCommunityDigest": null,
      "SupportTeamUserEmail": null,
      "InvalidLoginAttempts": 0,
      "LastLoginAttempt": null,
      "NextHelpDeskMessageReminder": null,
      "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": "User 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
}

​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