Search Users

GET

api

sys

users

Search Users

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

import requests

url = "https://spaces.nexudus.com/api/sys/users"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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 the full name value for this user.

string

Filter by the email value for this user.

string

Filter by the access token value for this user.

integer

Filter by the language value for this user.

integer

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

string

Filter by the new password value for this user.

string

Filter by the password value for this user.

string

Filter by the password salt value for this user.

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 application linked to this record.

string

Filter by the passport number value for this user.

string

Filter by the passport card number value for this user.

boolean

Filter by whether enable passport access is enabled.

boolean

Filter by whether this user is currently active.

boolean

Filter by whether is admin is enabled.

boolean

Filter by whether api access is enabled.

boolean

Filter by whether validated is enabled.

boolean

Filter by whether must reset password is enabled.

string

Filter by date/time value for last access.

string

Filter by the devices value for this user.

boolean

Filter by whether on new email is enabled.

boolean

Filter by whether on help desk msg is enabled.

boolean

Filter by whether on new wall post is enabled.

boolean

Filter by whether on new member is enabled.

boolean

Filter by whether on profile changes is enabled.

boolean

Filter by whether on new blog comment is enabled.

boolean

Filter by whether on new event comment is enabled.

boolean

Filter by whether on tariff change is enabled.

boolean

Filter by whether on booking change is enabled.

boolean

Filter by whether on tentative booking change is enabled.

boolean

Filter by whether on purchases is enabled.

boolean

Filter by whether on visitor registration is enabled.

boolean

Filter by whether on plaform invoices is enabled.

boolean

Filter by whether receive community digest is enabled.

boolean

Filter by whether receive every message is enabled.

boolean

Filter by whether two factor enabled is enabled.

string

Filter by the two factor secret value for this user.

string

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

integer

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

integer

Filter by the last help visited value for this user.

string

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

string

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

string

Filter by date/time value for next community digest.

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.

boolean

Filter by whether on access control errors is enabled.

string

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

boolean

Filter by whether on member removed from team is enabled.

boolean

Filter by whether on virtual office tariff change is enabled.

boolean

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

boolean

Filter by whether on identity check update is enabled.

Range Filters

string

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

string

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

integer

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

integer

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

string

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

string

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

string

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

string

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

string

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

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.

string

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

string

Filter by date/time value for next help desk message reminder 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, 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.

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,
      "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
}

Get one UserRetrieve a single User record by its Id.

Search Users

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

import requests

url = "https://spaces.nexudus.com/api/sys/users"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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