Skip to main content
GET
/
api
/
sys
/
users
/
{id}
{
  "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>"
}

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

id
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"

Response

200

FullName
string
Full Name.
Email
string
Email.
AccessToken
string
Access Token.
Language
integer
Language.
PreferredLanguageId
integer
Preferred Language Id.
NewPassword
string
New Password.
Password
string
Password.
PasswordSalt
string
Password Salt.
AvatarFileName
string
Avatar File Name.
NewAvatarUrl
string
New Avatar Url.
ClearAvatarFile
boolean
Clear Avatar File.
ApplicationId
integer
Application Id.
PassportNumber
string
Passport Number.
PassportCardNumber
string
Passport Card Number.
EnablePassportAccess
boolean
Enable Passport Access.
Active
boolean
Active.
IsAdmin
boolean
Is Admin.
APIAccess
boolean
APIAccess.
Validated
boolean
Validated.
MustResetPassword
boolean
Must Reset Password.
LastAccess
string
Last Access.
Devices
string
Devices.
OnNewEmail
boolean
On New Email.
OnHelpDeskMsg
boolean
On Help Desk Msg.
OnNewWallPost
boolean
On New Wall Post.
OnNewMember
boolean
On New Member.
OnProfileChanges
boolean
On Profile Changes.
OnNewBlogComment
boolean
On New Blog Comment.
OnNewEventComment
boolean
On New Event Comment.
OnTariffChange
boolean
On Tariff Change.
OnBookingChange
boolean
On Booking Change.
OnTentativeBookingChange
boolean
On Tentative Booking Change.
OnPurchases
boolean
On Purchases.
OnVisitorRegistration
boolean
On Visitor Registration.
OnPlaformInvoices
boolean
On Plaform Invoices.
ReceiveCommunityDigest
boolean
Receive Community Digest.
ReceiveEveryMessage
boolean
Receive Every Message.
TwoFactorEnabled
boolean
Two Factor Enabled.
TwoFactorSecret
string
Two Factor Secret.
EmailCallBackGuid
string
Email Call Back Guid.
Businesses
integer[]
Businesses.
UserRoles
integer[]
User Roles.
ChatRooms
integer[]
Chat Rooms.
DefaultBusinessId
integer
Default Business Id.
LastHelpVisited
integer
Last Help Visited.
LastReceivedCommunityThreadDate
string
Last Received Community Thread Date.
LastReceivedCommunityMessageDate
string
Last Received Community Message Date.
NextCommunityDigest
string
Next Community Digest.
SupportTeamUserEmail
string
Support Team User Email.
InvalidLoginAttempts
integer
Invalid Login Attempts.
LastLoginAttempt
string
Last Login Attempt.
OnAccessControlErrors
boolean
On Access Control Errors.
NextHelpDeskMessageReminder
string
Next Help Desk Message Reminder.
OnMemberRemovedFromTeam
boolean
On Member Removed From Team.
OnVirtualOfficeTariffChange
boolean
On Virtual Office Tariff Change.
OnVirtualOfficeDeliveryPreferenceUpdate
boolean
On Virtual Office Delivery Preference Update.
OnIdentityCheckUpdate
boolean
On Identity Check Update.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
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
}