HighLevel: Get Conversation

← Conversations operations · Get started

Operation gohighlevel.get_conversation

Provider route: GET /conversations/{conversationId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["conversations"]["getConversation"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.conversations.getConversation(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.conversations.get_conversation(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.conversationId	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Conversation — response body

Referenced models: Get Conversation — response body

Schemas

Get Conversation — response body

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	Unique identifier of the team member currently responsible for handling this conversation
contactId	string	Required within parent	Unique identifier of the contact associated with this conversation
deleted	boolean	Required within parent	Flag indicating if this conversation has been moved to trash/deleted
id	string	Required within parent	Unique identifier for this specific conversation thread
inbox	boolean	Required within parent	Flag indicating if this conversation is currently in the main inbox view
locationId	string	Required within parent	Unique identifier of the business location where this conversation takes place
starred	boolean	Optional	Flag indicating if this conversation has been marked as important/starred by the user
type	JSON	Required within parent
type (anyOf 1)	number	Alternative	Communication channel type for this conversation: 1 (Phone), 2 (Email), 3 (Facebook Messenger), 4 (Review), 5 (Group SMS), 6 (Internal Chat - coming soon)
type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unreadCount	JSON	Required within parent
unreadCount (anyOf 1)	number	Alternative	Number of messages in this conversation that have not been read by the user
unreadCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_conversation. Catalog operation: get-conversation. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["conversations.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source