Search Users

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.

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

User_FullName

string

Filter by Full Name.

User_Email

string

Filter by Email.

User_AccessToken

string

Filter by Access Token.

User_Language

integer

Filter by Language.

User_PreferredLanguage

integer

Filter by Preferred Language Id.

User_NewPassword

string

Filter by New Password.

User_Password

string

Filter by Password.

User_PasswordSalt

string

Filter by Password Salt.

User_AvatarFileName

string

Filter by Avatar File Name.

User_NewAvatarUrl

string

Filter by New Avatar Url.

User_ClearAvatar

boolean

Filter by Clear Avatar File.

User_Application

integer

Filter by Application Id.

User_PassportNumber

string

Filter by Passport Number.

User_PassportCardNumber

string

Filter by Passport Card Number.

User_EnablePassportAccess

boolean

Filter by Enable Passport Access.

User_Active

boolean

Filter by Active.

User_IsAdmin

boolean

Filter by Is Admin.

User_APIAccess

boolean

Filter by APIAccess.

User_Validated

boolean

Filter by Validated.

User_MustResetPassword

boolean

Filter by Must Reset Password.

User_LastAccess

string

Filter by Last Access.

User_Devices

string

Filter by Devices.

User_OnNewEmail

boolean

Filter by On New Email.

User_OnHelpDeskMsg

boolean

Filter by On Help Desk Msg.

User_OnNewWallPost

boolean

Filter by On New Wall Post.

User_OnNewMember

boolean

Filter by On New Member.

User_OnProfileChanges

boolean

Filter by On Profile Changes.

User_OnNewBlogComment

boolean

Filter by On New Blog Comment.

User_OnNewEventComment

boolean

Filter by On New Event Comment.

User_OnTariffChange

boolean

Filter by On Tariff Change.

User_OnBookingChange

boolean

Filter by On Booking Change.

User_OnTentativeBookingChange

boolean

Filter by On Tentative Booking Change.

User_OnPurchases

boolean

Filter by On Purchases.

User_OnVisitorRegistration

boolean

Filter by On Visitor Registration.

User_OnPlaformInvoices

boolean

Filter by On Plaform Invoices.

User_ReceiveCommunityDigest

boolean

Filter by Receive Community Digest.

User_ReceiveEveryMessage

boolean

Filter by Receive Every Message.

User_TwoFactorEnabled

boolean

Filter by Two Factor Enabled.

User_TwoFactorSecret

string

Filter by Two Factor Secret.

User_EmailCallBackGuid

string

Filter by Email Call Back Guid.

User_DefaultBusiness

integer

Filter by Default Business Id.

User_LastHelpVisited

integer

Filter by Last Help Visited.

User_LastReceivedCommunityThreadDate

string

Filter by Last Received Community Thread Date.

User_LastReceivedCommunityMessageDate

string

Filter by Last Received Community Message Date.

User_NextCommunityDigest

string

Filter by Next Community Digest.

User_SupportTeamUserEmail

string

Filter by Support Team User Email.

Filter by Invalid Login Attempts.

Filter by Last Login Attempt.

User_OnAccessControlErrors

boolean

Filter by On Access Control Errors.

User_NextHelpDeskMessageReminder

string

Filter by Next Help Desk Message Reminder.

User_OnMemberRemovedFromTeam

boolean

Filter by On Member Removed From Team.

User_OnVirtualOfficeTariffChange

boolean

Filter by On Virtual Office Tariff Change.

User_OnVirtualOfficeDeliveryPreferenceUpdate

boolean

Filter by On Virtual Office Delivery Preference Update.

User_OnIdentityCheckUpdate

boolean

Filter by On Identity Check Update.

Range Filters

from_User_LastAccess

string

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

to_User_LastAccess

string

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

from_User_LastHelpVisited

integer

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

to_User_LastHelpVisited

integer

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

from_User_LastReceivedCommunityThreadDate

string

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

to_User_LastReceivedCommunityThreadDate

string

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

from_User_LastReceivedCommunityMessageDate

string

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

to_User_LastReceivedCommunityMessageDate

string

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

from_User_NextCommunityDigest

string

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

to_User_NextCommunityDigest

string

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

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

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

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

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

from_User_NextHelpDeskMessageReminder

string

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

to_User_NextHelpDeskMessageReminder

string

Filter by 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=1" \
  -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=1" \
  -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=-1" \
  -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 included 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 (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": [
    {
      "FullName": "",
      "Email": "",
      "AccessToken": null,
      "Language": 0,
      "PreferredLanguageId": null,
      "NewPassword": null,
      "Password": null,
      "PasswordSalt": "",
      "AvatarFileName": null,
      "NewAvatarUrl": null,
      "ClearAvatarFile": null,
      "ApplicationId": null,
      "PassportNumber": null,
      "PassportCardNumber": null,
      "EnablePassportAccess": false,
      "Active": false,
      "IsAdmin": false,
      "APIAccess": false,
      "Validated": false,
      "MustResetPassword": false,
      "LastAccess": null,
      "Devices": null,
      "OnNewEmail": false,
      "OnHelpDeskMsg": false,
      "OnNewWallPost": false,
      "OnNewMember": false,
      "OnProfileChanges": false,
      "OnNewBlogComment": false,
      "OnNewEventComment": false,
      "OnTariffChange": false,
      "OnBookingChange": false,
      "OnTentativeBookingChange": false,
      "OnPurchases": false,
      "OnVisitorRegistration": false,
      "OnPlaformInvoices": false,
      "ReceiveCommunityDigest": false,
      "ReceiveEveryMessage": false,
      "TwoFactorEnabled": false,
      "TwoFactorSecret": null,
      "EmailCallBackGuid": null,
      "Businesses": [],
      "UserRoles": [],
      "ChatRooms": [],
      "DefaultBusinessId": null,
      "LastHelpVisited": 0,
      "LastReceivedCommunityThreadDate": null,
      "LastReceivedCommunityMessageDate": null,
      "NextCommunityDigest": null,
      "SupportTeamUserEmail": null,
      "InvalidLoginAttempts": 0,
      "LastLoginAttempt": null,
      "OnAccessControlErrors": false,
      "NextHelpDeskMessageReminder": null,
      "OnMemberRemovedFromTeam": false,
      "OnVirtualOfficeTariffChange": false,
      "OnVirtualOfficeDeliveryPreferenceUpdate": false,
      "OnIdentityCheckUpdate": 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": "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
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

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

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by FullName

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by FullName

Range filters

Response

200