> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one CoworkerMessage

> Retrieve a single CoworkerMessage record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CoworkerMessage record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkermessages/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

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

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  Customer sending or receiving the message.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Customer full name.
</ResponseField>

<ResponseField name="CoworkerEmail" type="string">
  Customer email address.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Customer billing name.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Customer company name.
</ResponseField>

<ResponseField name="EmailAccountId" type="integer">
  Email account used to send or receive the message. If not set, the default email settings configured for the location are used.
</ResponseField>

<ResponseField name="EmailAccountDisplayName" type="string">
  Email account display name.
</ResponseField>

<ResponseField name="EmailAccountEmailAddress" type="string">
  Email account email address.
</ResponseField>

<ResponseField name="Subject" type="string">
  Message subject.
</ResponseField>

<ResponseField name="Body" type="string">
  Message body.
</ResponseField>

<ResponseField name="IsNewMessage" type="boolean">
  Whether the message has not been read yet.
</ResponseField>

<ResponseField name="Incoming" type="boolean">
  Whether the message was received from the customer (true) or sent to the customer (false).
</ResponseField>

<ResponseField name="MessageId" type="integer">
  Automated message template that triggered this message, if sent by the system.
</ResponseField>

<ResponseField name="ReminderUniqueId" type="string">
  Unique identifier of the reminder that triggered this message, if any.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```
