Get conversation - Automate.ax

highlevel.getConversation retrieves one conversation by ID.

automations/highlevel-get-conversation.automation.ts

import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("Get conversation", () => {
  markSignificant(
    highlevel.getConversation({
      conversationId: "tDtDnQdgm2LXpyiqYvZ6",
    }),
  )
})

Input

Field	Type	Required	Description
`conversationId`	`string`	Yes	HighLevel conversation 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
`contactId`	`string`	Yes	Unique identifier of the contact associated with this conversation
`locationId`	`string`	Yes	Unique identifier of the business location where this conversation takes place
`deleted`	`boolean`	Yes	Flag indicating if this conversation has been moved to trash/deleted
`inbox`	`boolean`	Yes	Flag indicating if this conversation is currently in the main inbox view
`type`	`number`	Yes	Communication channel type for this conversation: 1 (Phone), 2 (Email), 3 (Facebook Messenger), 4 (Review), 5 (Group SMS), 6 (Internal Chat - coming soon)
`unreadCount`	`number`	Yes	Number of messages in this conversation that have not been read by the user
`assignedTo`	`string`	No	Unique identifier of the team member currently responsible for handling this conversation
`id`	`string`	Yes	Unique identifier for this specific conversation thread
`starred`	`boolean`	No	Flag indicating if this conversation has been marked as important/starred by the user

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