HighLevel: Get Workflow Campaign by ID

← Emails operations · Get started

Operation gohighlevel.get_workflow_campaign

Provider route: GET /emails/locations/{locationId}/campaigns/workflows/{campaignId}. 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["emails"]["getWorkflowCampaign"]>[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.emails.getWorkflowCampaign(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.emails.get_workflow_campaign(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.locationId	string	Required within parent
path.campaignId	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 Workflow Campaign by ID — response body

Referenced models: Get Workflow Campaign by ID — response body

Schemas

Get Workflow Campaign by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Optional	Whether the campaign is deleted
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Optional	Campaign status Known values: published, draft
subSources	array	Optional	Sub-sources (email-sending steps) within this workflow. Each entry's `id` can be passed as the `subSourceId` query parameter to the campaign stats endpoint to retrieve per-step stats.
subSources[]	Model	Each item	Expand Get Workflow Campaign by ID — response body — sub Sources item
traceId	string	Optional	Trace ID of the request
updatedAt	string	Required within parent	Updated at timestamp

Referenced models: Get Workflow Campaign by ID — response body — sub Sources item

Get Workflow Campaign by ID — response body — sub Sources item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Optional	Timestamp when this step was added to the workflow
editorContentUrl	string	Optional	URL to fetch the rendered step content as HTML. Issue a GET against this URL to retrieve the body.
editorType	string	Optional	Editor type for this step Known values: html, builder, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
id	string	Required within parent	Sub-source identifier (workflow step). Pass this value as the `subSourceId` query parameter on the campaign stats endpoint to retrieve stats scoped to this step.
isPlainText	boolean	Optional	Whether this step uses plain text
name	string	Optional	Workflow step name
previewText	string	Optional	Preview text
subject	string	Optional	Email subject line
updatedAt	string	Optional	Timestamp when this step was last updated

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_workflow_campaign. Catalog operation: get-workflow-campaign. 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: ["emails/campaigns.readonly"]

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

Official provider source