Get one User

GET

api

sys

users

{id}

Get one User

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

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

fetch('https://spaces.nexudus.com/api/sys/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "FullName": "<string>",
  "Email": "<string>",
  "AccessToken": "<string>",
  "Language": 123,
  "PreferredLanguageId": 123,
  "NewPassword": "<string>",
  "Password": "<string>",
  "PasswordSalt": "<string>",
  "AvatarFileName": "<string>",
  "NewAvatarUrl": "<string>",
  "ClearAvatarFile": true,
  "ApplicationId": 123,
  "PassportNumber": "<string>",
  "PassportCardNumber": "<string>",
  "EnablePassportAccess": true,
  "Active": true,
  "IsAdmin": true,
  "APIAccess": true,
  "Validated": true,
  "MustResetPassword": true,
  "LastAccess": "<string>",
  "Devices": "<string>",
  "OnNewEmail": true,
  "OnHelpDeskMsg": true,
  "OnNewWallPost": true,
  "OnNewMember": true,
  "OnProfileChanges": true,
  "OnNewBlogComment": true,
  "OnNewEventComment": true,
  "OnTariffChange": true,
  "OnBookingChange": true,
  "OnTentativeBookingChange": true,
  "OnPurchases": true,
  "OnVisitorRegistration": true,
  "OnPlaformInvoices": true,
  "ReceiveCommunityDigest": true,
  "ReceiveEveryMessage": true,
  "TwoFactorEnabled": true,
  "TwoFactorSecret": "<string>",
  "EmailCallBackGuid": "<string>",
  "Businesses": [
    123
  ],
  "UserRoles": [
    123
  ],
  "ChatRooms": [
    123
  ],
  "DefaultBusinessId": 123,
  "LastHelpVisited": 123,
  "LastReceivedCommunityThreadDate": "<string>",
  "LastReceivedCommunityMessageDate": "<string>",
  "NextCommunityDigest": "<string>",
  "SupportTeamUserEmail": "<string>",
  "InvalidLoginAttempts": 123,
  "LastLoginAttempt": "<string>",
  "OnAccessControlErrors": true,
  "NextHelpDeskMessageReminder": "<string>",
  "OnMemberRemovedFromTeam": true,
  "OnVirtualOfficeTariffChange": true,
  "OnVirtualOfficeDeliveryPreferenceUpdate": true,
  "OnIdentityCheckUpdate": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the User record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/users/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/users/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/users/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

Required full name shown for this staff account..

string

Required valid email address used to identify and sign in to this staff account..

string

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

integer

Legacy language setting; use PreferredLanguage instead.. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

integer

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

string

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

string

Stored password hash; never expose or set it directly..

string

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

string

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

string

URL of a new file to upload as the avatar.

boolean

Set to true to remove the current avatar file.

integer

ID of the optional marketplace application whose integration uses this account..

string

Read-only Nexudus Passport identifier; the platform verifies that it is unique..

string

Read-only Nexudus Passport card code; it must be a valid unused Passport card..

boolean

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

boolean

Whether this staff account is active; notification recipient queries generally require an active account..

boolean

Whether this account has administrator access in addition to any permissions granted through UserRoles..

boolean

Whether this account may authenticate for API access..

boolean

Whether the platform marks this account as validated..

boolean

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

string

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

string

Registered device identifiers used for device-based authentication; manage them outside the Admin Agent..

boolean

Whether to notify this active user about new internal messages for their locations..

boolean

Whether to notify this active user about new help desk messages for their locations..

boolean

Whether to notify this active user about new community wall posts for their locations..

boolean

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

boolean

Whether to notify this user about customer profile changes..

boolean

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

boolean

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

boolean

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

boolean

Whether to notify this active user about booking changes for their locations..

boolean

Whether to notify this active user about tentative booking changes for their locations..

boolean

Whether to notify this active user about purchases for their locations..

boolean

Whether to notify this user when visitors register at their locations..

boolean

Whether to notify this user about Nexudus platform invoices for their locations..

boolean

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

boolean

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

boolean

Read-only indicator of whether two-factor authentication is enabled for this account..

string

Two-factor authentication secret; never expose or set it..

string

Internal token-invalidating password-hash claim; never expose or set it..

integer[]

List of locations this staff account can access; the account is included in location-scoped user queries only when linked to that location..

integer[]

List of location-scoped user roles that grant this account permissions; administrator access may grant permissions independently..

integer[]

Internal list of support chat rooms linked to this user; manage chat membership outside the Admin Agent..

integer

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

integer

Internal identifier of the last help page viewed by this user..

string

Internal timestamp of the latest community thread included in this user’s notification tracking..

string

Internal timestamp of the latest community message included in this user’s notification tracking..

string

Internal timestamp for this user’s next scheduled community digest..

string

Internal support-team routing email associated with this account..

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

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

boolean

Whether to notify this user about access-control errors for their locations..

string

Timestamp of the next help desk message reminder for this user..

boolean

Whether to notify this user when a customer is removed from a team..

boolean

Whether to notify this active user about virtual-office plan changes for their locations..

boolean

Whether to notify this user when a virtual-office customer updates delivery preferences..

boolean

Whether to notify this user when a customer’s identity-check status changes..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get one User

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

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

fetch('https://spaces.nexudus.com/api/sys/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "FullName": "<string>",
  "Email": "<string>",
  "AccessToken": "<string>",
  "Language": 123,
  "PreferredLanguageId": 123,
  "NewPassword": "<string>",
  "Password": "<string>",
  "PasswordSalt": "<string>",
  "AvatarFileName": "<string>",
  "NewAvatarUrl": "<string>",
  "ClearAvatarFile": true,
  "ApplicationId": 123,
  "PassportNumber": "<string>",
  "PassportCardNumber": "<string>",
  "EnablePassportAccess": true,
  "Active": true,
  "IsAdmin": true,
  "APIAccess": true,
  "Validated": true,
  "MustResetPassword": true,
  "LastAccess": "<string>",
  "Devices": "<string>",
  "OnNewEmail": true,
  "OnHelpDeskMsg": true,
  "OnNewWallPost": true,
  "OnNewMember": true,
  "OnProfileChanges": true,
  "OnNewBlogComment": true,
  "OnNewEventComment": true,
  "OnTariffChange": true,
  "OnBookingChange": true,
  "OnTentativeBookingChange": true,
  "OnPurchases": true,
  "OnVisitorRegistration": true,
  "OnPlaformInvoices": true,
  "ReceiveCommunityDigest": true,
  "ReceiveEveryMessage": true,
  "TwoFactorEnabled": true,
  "TwoFactorSecret": "<string>",
  "EmailCallBackGuid": "<string>",
  "Businesses": [
    123
  ],
  "UserRoles": [
    123
  ],
  "ChatRooms": [
    123
  ],
  "DefaultBusinessId": 123,
  "LastHelpVisited": 123,
  "LastReceivedCommunityThreadDate": "<string>",
  "LastReceivedCommunityMessageDate": "<string>",
  "NextCommunityDigest": "<string>",
  "SupportTeamUserEmail": "<string>",
  "InvalidLoginAttempts": 123,
  "LastLoginAttempt": "<string>",
  "OnAccessControlErrors": true,
  "NextHelpDeskMessageReminder": "<string>",
  "OnMemberRemovedFromTeam": true,
  "OnVirtualOfficeTariffChange": true,
  "OnVirtualOfficeDeliveryPreferenceUpdate": true,
  "OnIdentityCheckUpdate": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200