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>'

import requests

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

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/{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

The full name value for this user.

string

The email value for this user.

string

The access token value for this user.

integer

The language value for this user. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

integer

ID of the preferred language linked to this record.

string

The new password value for this user.

string

The password value for this user.

string

The password salt value for this user.

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

string

The passport number value for this user.

string

The passport card number value for this user.

boolean

Whether enable passport access is enabled.

boolean

Whether this user is currently active.

boolean

Whether is admin is enabled.

boolean

Whether api access is enabled.

boolean

Whether validated is enabled.

boolean

Whether must reset password is enabled.

string

Date/time value for last access.

string

The devices value for this user.

boolean

Whether on new email is enabled.

boolean

Whether on help desk msg is enabled.

boolean

Whether on new wall post is enabled.

boolean

Whether on new member is enabled.

boolean

Whether on profile changes is enabled.

boolean

Whether on new blog comment is enabled.

boolean

Whether on new event comment is enabled.

boolean

Whether on tariff change is enabled.

boolean

Whether on booking change is enabled.

boolean

Whether on tentative booking change is enabled.

boolean

Whether on purchases is enabled.

boolean

Whether on visitor registration is enabled.

boolean

Whether on plaform invoices is enabled.

boolean

Whether receive community digest is enabled.

boolean

Whether receive every message is enabled.

boolean

Whether two factor enabled is enabled.

string

The two factor secret value for this user.

string

Unique identifier (GUID) for the email call back.

integer[]

List of businesses linked to this record.

integer[]

List of user roles linked to this record.

integer[]

List of chat rooms linked to this record.

integer

ID of the default business linked to this record.

integer

The last help visited value for this user.

string

Date/time value for last received community thread date.

string

Date/time value for last received community message date.

string

Date/time value for next community digest.

string

The support team user email value for this user.

The invalid login attempts value for this user.

Date/time value for last login attempt.

boolean

Whether on access control errors is enabled.

string

Date/time value for next help desk message reminder.

boolean

Whether on member removed from team is enabled.

boolean

Whether on virtual office tariff change is enabled.

boolean

Whether on virtual office delivery preference update is enabled.

boolean

Whether on identity check update is enabled.

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 multiple UsersRetrieve multiple User records by their Ids in a single request.

Get one User

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

import requests

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

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/{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