Get one UserMessage

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

import requests

url = "https://spaces.nexudus.com/api/sys/usermessages/{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/usermessages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer[]

List of to users linked to this record.

string

Display name of the linked from (read-only).

integer

ID of the from user linked to this record.

string

The header value for this user message.

string

The body value for this user message.

boolean

Whether is read 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

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

Get multiple UserMessagesRetrieve multiple UserMessage records by their Ids in a single request.

Get one UserMessage

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

import requests

url = "https://spaces.nexudus.com/api/sys/usermessages/{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/usermessages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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