Search Users

GET

api

sys

users

Search Users

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/users', 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 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

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

string

Filter by required full name shown for this staff account..

string

Filter by required valid email address used to identify and sign in to this staff account..

string

Filter by authentication token generated by the platform; never expose or set it..

integer

Filter by legacy language setting; use PreferredLanguage instead..

integer

Filter by iD of the optional location language used for this account’s preferred interface and content language..

string

Filter by new sign-in password; do not expose or set passwords through the Admin Agent..

string

Filter by stored password hash; never expose or set it directly..

string

Filter by password-hashing salt generated by the platform; never expose or set it..

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.

integer

Filter by iD of the optional marketplace application whose integration uses this account..

string

Filter by read-only Nexudus Passport identifier; the platform verifies that it is unique..

string

Filter by read-only Nexudus Passport card code; it must be a valid unused Passport card..

boolean

Filter by whether this account is eligible for Nexudus Passport access; the platform enables it on user creation..

boolean

Filter by whether this staff account is active; notification recipient queries generally require an active account..

boolean

Filter by whether this account has administrator access in addition to any permissions granted through UserRoles..

boolean

Filter by whether this account may authenticate for API access..

boolean

Filter by whether the platform marks this account as validated..

boolean

Filter by whether the user must reset their sign-in password; the platform sets this when it generates a password..

string

Filter by read-only UTC timestamp of the latest account access, rounded down to the nearest 15 minutes..

string

Filter by registered device identifiers used for device-based authentication; manage them outside the Admin Agent..

boolean

Filter by whether to notify this active user about new internal messages for their locations..

boolean

Filter by whether to notify this active user about new help desk messages for their locations..

boolean

Filter by whether to notify this active user about new community wall posts for their locations..

boolean

Filter by whether to notify this active user when a new customer profile is created for their locations..

boolean

Filter by whether to notify this user about customer profile changes..

boolean

Filter by whether to notify this active user with a customer profile at the location about new blog comments..

boolean

Filter by whether to notify this active user with a customer profile at the location about new calendar-event comments..

boolean

Filter by whether to notify this active user about plan changes; virtual-office plans instead use OnVirtualOfficeTariffChange..

boolean

Filter by whether to notify this active user about booking changes for their locations..

boolean

Filter by whether to notify this active user about tentative booking changes for their locations..

boolean

Filter by whether to notify this active user about purchases for their locations..

boolean

Filter by whether to notify this user when visitors register at their locations..

boolean

Filter by whether to notify this user about Nexudus platform invoices for their locations..

boolean

Filter by whether this user is subscribed to scheduled community-board digest emails; new accounts inherit the location digest setting..

boolean

Filter by whether this user receives an email for each new community-board message instead of only digest notifications..

boolean

Filter by read-only indicator of whether two-factor authentication is enabled for this account..

string

Filter by two-factor authentication secret; never expose or set it..

string

Filter by internal token-invalidating password-hash claim; never expose or set it..

integer

Filter by read-only ID of the user’s default location; the platform falls back to the first linked location when it is empty..

integer

Filter by internal identifier of the last help page viewed by this user..

string

Filter by internal timestamp of the latest community thread included in this user’s notification tracking..

string

Filter by internal timestamp of the latest community message included in this user’s notification tracking..

string

Filter by internal timestamp for this user’s next scheduled community digest..

string

Filter by internal support-team routing email associated with this account..

Filter by internal count of failed login attempts; the platform resets it after a successful password change and applies its lockout threshold..

Filter by internal timestamp of the most recent failed login attempt, used with InvalidLoginAttempts for lockout handling..

boolean

Filter by whether to notify this user about access-control errors for their locations..

string

Filter by timestamp of the next help desk message reminder for this user..

boolean

Filter by whether to notify this user when a customer is removed from a team..

boolean

Filter by whether to notify this active user about virtual-office plan changes for their locations..

boolean

Filter by whether to notify this user when a virtual-office customer updates delivery preferences..

boolean

Filter by whether to notify this user when a customer’s identity-check status changes..

Range Filters

string

Filter by read-only UTC timestamp of the latest account access, rounded down to the nearest 15 minutes. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp of the latest account access, rounded down to the nearest 15 minutes. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by internal identifier of the last help page viewed by this user. greater than or equal to this value.

integer

Filter by internal identifier of the last help page viewed by this user. less than or equal to this value.

string

Filter by internal timestamp of the latest community thread included in this user’s notification tracking. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal timestamp of the latest community thread included in this user’s notification tracking. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal timestamp of the latest community message included in this user’s notification tracking. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal timestamp of the latest community message included in this user’s notification tracking. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal timestamp for this user’s next scheduled community digest. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal timestamp for this user’s next scheduled community digest. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

Filter by internal count of failed login attempts; the platform resets it after a successful password change and applies its lockout threshold. greater than or equal to this value.

Filter by internal count of failed login attempts; the platform resets it after a successful password change and applies its lockout threshold. less than or equal to this value.

Filter by internal timestamp of the most recent failed login attempt, used with InvalidLoginAttempts for lockout handling. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

Filter by internal timestamp of the most recent failed login attempt, used with InvalidLoginAttempts for lockout handling. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

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

string

Filter by timestamp of the next help desk message reminder for this user. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/users?' + 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/sys/users',
    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/sys/users?User_FullName=example-value&orderBy=FullName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/users?' + new URLSearchParams({
    User_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/sys/users',
    params={
        'User_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/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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/users?' + new URLSearchParams({
    from_User_UpdatedOn: '2025-01-01T00:00',
    to_User_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/sys/users',
    params={
        'from_User_UpdatedOn': '2025-01-01T00:00',
        'to_User_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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

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": [
    {
      "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,
      "IsAdmin": 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
}

Search Users

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/users', 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