Skip to main content
GET
/
api
/
spaces
/
coworkermessages
/
{id}
Get one CoworkerMessage
curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkermessages/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "EmailAccountId": 123,
  "EmailAccountDisplayName": "<string>",
  "EmailAccountEmailAddress": "<string>",
  "Subject": "<string>",
  "Body": "<string>",
  "IsNewMessage": true,
  "Incoming": true,
  "MessageId": 123,
  "ReminderUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A message sent to or received from a customer. These can be sent using the default email settings associated with the location or via any of the connected email accounts. Messages can be composed directly from a customer’s record in the Admin Panel. Use Incoming to distinguish messages received from a customer from messages sent to them.

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

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
CoworkerId
integer
Customer sending or receiving the message.
​
CoworkerFullName
string
Customer full name.
​
CoworkerEmail
string
Customer email address.
​
CoworkerBillingName
string
Customer billing name.
​
CoworkerCompanyName
string
Customer company name.
​
EmailAccountId
integer
Email account used to send or receive the message. If not set, the default email settings configured for the location are used.
​
EmailAccountDisplayName
string
Email account display name.
​
EmailAccountEmailAddress
string
Email account email address.
​
Subject
string
Message subject.
​
Body
string
Message body.
​
IsNewMessage
boolean
Whether the message has not been read yet.
​
Incoming
boolean
Whether the message was received from the customer (true) or sent to the customer (false).
​
MessageId
integer
Automated message template that triggered this message, if sent by the system.
​
ReminderUniqueId
string
Unique identifier of the reminder that triggered this message, if any.
​
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
{
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerEmail": null,
  "CoworkerBillingName": null,
  "CoworkerCompanyName": null,
  "EmailAccountId": null,
  "EmailAccountDisplayName": null,
  "EmailAccountEmailAddress": null,
  "Subject": null,
  "Body": null,
  "IsNewMessage": false,
  "Incoming": false,
  "MessageId": 0,
  "ReminderUniqueId": null,
  "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": "CoworkerMessage Example",
  "LocalizationDetails": null,
  "CustomFields": null
}