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

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

Customer sending or receiving the message.

string

Customer full name.

string

Customer email address.

string

Customer billing name.

string

Customer company name.

integer

Email account used to send or receive the message. If not set, the default email settings configured for the location are used.

string

Email account display name.

string

Email account email address.

string

Message subject.

string

Message body.

boolean

Whether the message has not been read yet.

boolean

Whether the message was received from the customer (true) or sent to the customer (false).

integer

Automated message template that triggered this message, if sent by the system.

string

Unique identifier of the reminder that triggered this message, if any.

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,
  "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 multiple CoworkerMessagesRetrieve multiple CoworkerMessage records by their Ids in a single request.

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