Search conversations - Automate.ax

highlevel.searchConversations searches conversations by contact, assignment, status, and pagination.

automations/highlevel-search-conversations.automation.ts

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

export default automation("Search conversations", () => {
  markSignificant(highlevel.searchConversations({}))
})

Input

Field	Type	Required	Description
`contactId`	`string`	No	HighLevel contact id value.
`assignedTo`	`string`	No	HighLevel assigned to value.
`followers`	`string`	No	HighLevel followers value.
`mentions`	`string`	No	HighLevel mentions value.
`query`	`string`	No	HighLevel query value.
`sort`	`asc \| desc`	No	HighLevel sort value.
`startAfterDate`	`any`	No	HighLevel start after date value.
`id`	`string`	No	HighLevel id value.
`limit`	`number`	No	HighLevel limit value.
`lastMessageType`	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	No	HighLevel last message type value.
`lastMessageAction`	`automated \| manual`	No	HighLevel last message action value.
`lastMessageDirection`	`inbound \| outbound`	No	HighLevel last message direction value.
`status`	`all \| read \| unread \| starred \| recents`	No	HighLevel status value.
`sortBy`	`last_manual_message_date \| last_message_date \| score_profile \| overdue_at \| due_at`	No	HighLevel sort by value.
`sortScoreProfile`	`string`	No	HighLevel sort score profile value.
`scoreProfile`	`string`	No	HighLevel score profile value.
`scoreProfileMin`	`number`	No	HighLevel score profile min value.
`scoreProfileMax`	`number`	No	HighLevel score profile max value.
`startDate`	`number`	No	HighLevel start date value.
`endDate`	`number`	No	HighLevel end date 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
`conversations`	`object[]`	Yes	The list of all conversations found for the given query
`total`	`number`	Yes	Total Number of results found for the given query

This action calls GET /conversations/search 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.