Skip to main content
GET
/
api
/
sys
/
usermessages
/
{id}
Get one UserMessage
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/usermessages/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "ToUsers": [
    123
  ],
  "FromName": "<string>",
  "FromUserId": 123,
  "Header": "<string>",
  "Body": "<string>",
  "IsRead": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A UserMessage represents a direct message sent between administrators or from the system to an administrator within the platform.

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

​
Path Parameters

​
id
integer
required
The Id of the UserMessage record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
ToUsers
integer[]
List of to users linked to this record.
​
FromName
string
Display name of the linked from (read-only).
​
FromUserId
integer
ID of the from user linked to this record.
​
Header
string
The header value for this user message.
​
Body
string
The body value for this user message.
​
IsRead
boolean
Whether is read is enabled.
​
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
{
  "BusinessId": 0,
  "ToUsers": [],
  "FromName": null,
  "FromUserId": null,
  "Header": null,
  "Body": null,
  "IsRead": 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": "UserMessage Example",
  "LocalizationDetails": null,
  "CustomFields": null
}