HighLevel: Get email by Id

← Conversations operations · Get started

Operation gohighlevel.get_email_by_id

Provider route: GET /conversations/messages/email/{id}. 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"]["getEmailById"]>[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.getEmailById(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_email_by_id(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.id	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 email by Id — response body

Referenced models: Get email by Id — response body

Schemas

Get email by Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Optional	External Id
attachments	array	Optional	An array of attachment URLs.
attachments[]	string	Each item
bcc	array	Optional	List of email Ids of the people in the bcc field
bcc[]	string	Each item
body	string	Required within parent	Body content of the email message
cc	array	Optional	List of email Ids of the people in the cc field
cc[]	string	Each item
contactId	string	Required within parent	Contact ID associated with the email message
contentType	string	Required within parent	Content type of the email body
conversationId	string	Required within parent	Conversation ID associated with the email message
conversationProviderId	string	Optional	Conversation provider ID
dateAdded	string	Required within parent	Timestamp when the email message was created
direction	string	Required within parent	Direction of the email message Known values: inbound, outbound
from	string	Required within parent	Name and Email Id of the sender
id	string	Required within parent	Unique identifier for the email message
locationId	string	Required within parent	Location ID associated with the email message
provider	string	Optional	Email provider used to send or receive the message
replyToMessageId	string	Optional	In case of reply, email message Id of the reply to email
source	string	Optional	Email source Known values: workflow, bulk_actions, campaign, api, app
status	string	Optional	Delivery status of the email message Known values: pending, scheduled, sent, delivered, read, undelivered, connected, failed, opened
subject	string	Optional	Subject line of the email message
threadId	string	Required within parent	Message Id or thread Id
to	array	Required within parent	List of email Ids of the receivers
to[]	string	Each item

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_email_by_id. Catalog operation: get-email-by-id. 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/message.readonly"]

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

Official provider source