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

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Get message

> Retrieves one message by ID.

`highlevel.getMessage` retrieves one message by ID.

```ts automations/highlevel-get-message.automation.ts theme={null}
import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("Get message", () => {
  markSignificant(
    highlevel.getMessage({
      id: "value",
    }),
  )
})
```

## Input

| Field | Type     | Required | Description         |
| ----- | -------- | -------- | ------------------- |
| `id`  | `string` | Yes      | HighLevel id value. |

Automate.ax supplies the connected sub-account's location ID. Optional second argument `{ account }` selects a named HighLevel binding.

## Output

| Field                    | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Required | Description                                                                                                                                                              |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`                     | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel id value.                                                                                                                                                      |
| `type`                   | `number`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel type value.                                                                                                                                                    |
| `messageType`            | `TYPE_CALL \| TYPE_SMS \| TYPE_RCS \| TYPE_EMAIL \| TYPE_SMS_REVIEW_REQUEST \| TYPE_WEBCHAT \| TYPE_SMS_NO_SHOW_REQUEST \| TYPE_CAMPAIGN_SMS \| TYPE_CAMPAIGN_CALL \| TYPE_CAMPAIGN_EMAIL \| TYPE_CAMPAIGN_VOICEMAIL \| TYPE_FACEBOOK \| TYPE_CAMPAIGN_FACEBOOK \| TYPE_CAMPAIGN_MANUAL_CALL \| TYPE_CAMPAIGN_MANUAL_SMS \| TYPE_GMB \| TYPE_CAMPAIGN_GMB \| TYPE_REVIEW \| TYPE_INSTAGRAM \| TYPE_WHATSAPP \| TYPE_CUSTOM_SMS \| TYPE_CUSTOM_EMAIL \| TYPE_CUSTOM_PROVIDER_SMS \| TYPE_CUSTOM_PROVIDER_EMAIL \| TYPE_IVR_CALL \| TYPE_ACTIVITY_CONTACT \| TYPE_ACTIVITY_INVOICE \| TYPE_ACTIVITY_PAYMENT \| TYPE_ACTIVITY_OPPORTUNITY \| TYPE_LIVE_CHAT \| TYPE_LIVE_CHAT_INFO_MESSAGE \| TYPE_ACTIVITY_APPOINTMENT \| TYPE_FACEBOOK_COMMENT \| TYPE_INSTAGRAM_COMMENT \| TYPE_CUSTOM_CALL \| TYPE_INTERNAL_COMMENT \| TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG \| TYPE_TIKTOK \| TYPE_TIKTOK_COMMENT \| TYPE_ACTIVITY_WHATSAPP \| TYPE_FORM_SUBMISSION \| TYPE_SMS_REACTION` | Yes      | Type of the message as a string                                                                                                                                          |
| `locationId`             | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel location id value.                                                                                                                                             |
| `contactId`              | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel contact id value.                                                                                                                                              |
| `conversationId`         | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel conversation id value.                                                                                                                                         |
| `dateAdded`              | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel date added value.                                                                                                                                              |
| `body`                   | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | No       | HighLevel body value.                                                                                                                                                    |
| `direction`              | `inbound \| outbound`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Yes      | HighLevel direction value.                                                                                                                                               |
| `status`                 | `connected \| delivered \| failed \| opened \| pending \| read \| scheduled \| sent \| undelivered \| clicked \| opt_out \| queued`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | No       | HighLevel status value.                                                                                                                                                  |
| `contentType`            | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      | HighLevel content type value.                                                                                                                                            |
| `attachments`            | `string[]`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | No       | An array of attachment URLs. Attachments will be empty for Call and Voicemails, type 1 and 10. Please use get call recording API to fetch call recording and voicemails. |
| `meta`                   | `object`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | No       | HighLevel meta value.                                                                                                                                                    |
| `source`                 | `workflow \| bulk_actions \| campaign \| api \| app`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | No       | Message source                                                                                                                                                           |
| `userId`                 | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | No       | User Id                                                                                                                                                                  |
| `conversationProviderId` | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | No       | Conversation Provider Id                                                                                                                                                 |
| `chatWidgetId`           | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | No       | Chat Widget Id                                                                                                                                                           |

This action calls `GET /conversations/messages/{id}` with HighLevel API version `2021-04-15` and requires `conversations/message.readonly`. HighLevel validation and permission errors fail the action. Rate limits honor the provider's retry timing.