Get one CoworkerMessage

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

import requests

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

{
  "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>",
  "AiChannelSessionId": 123,
  "RfcMessageId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A customer message (CoworkerMessage) records an incoming or outgoing email communication associated with a customer; operators can create outbound messages and inspect message history by customer or connected email account.

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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer who sent or received this message; location access is determined through the customer’s InvoicingBusiness..

string

Display value for Coworker.FullName..

string

Display value for Coworker.Email..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.CompanyName..

integer

ID of the optional connected email account used to send or receive this message; when omitted, the customer’s location default email settings are used..

string

Display value for EmailAccount.DisplayName..

string

Display value for EmailAccount.EmailAddress..

string

Message subject, limited to 254 characters..

string

HTML message body; canned-response tokens are expanded for the customer before an outgoing email is queued..

boolean

Whether the message is unread; the system clears this flag when the message is updated..

boolean

Whether the message was received from the customer (true) rather than sent to the customer (false); inbound messages are created by the email integration..

integer

Internal identifier assigned by the email provider when importing a message; it is not an automated message template ID..

string

Internal unique identifier of the reminder that generated this message, when applicable..

integer

Internal ID of the AI channel session used to associate this message with an AI conversation timeline..

string

Internal RFC 5322 Message-ID header used for email threading and replies; generated by the sending workflow..

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

{
  "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,
  "AiChannelSessionId": null,
  "RfcMessageId": 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
}

Get one CoworkerMessage

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

import requests

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

{
  "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>",
  "AiChannelSessionId": 123,
  "RfcMessageId": "<string>",
  "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