HighLevel: List Bulk Action Campaigns

← Emails operations · Get started

Operation gohighlevel.list_bulk_action_campaigns

Provider route: GET /emails/locations/{locationId}/campaigns/bulk-actions. 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"]["listBulkActionCampaigns"]>[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.listBulkActionCampaigns(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.list_bulk_action_campaigns(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
query	object	Optional	Additional keys: not allowed
query.limit	number	Optional	Default: 10 Maximum: 20 Minimum: 1
query.offset	number	Optional	Default: 0 Minimum: 0
query.search	string	Optional	Default:
query.dateFrom	string	Optional
query.dateTo	string	Optional
query.status	string	Optional	One of: processing, scheduled, paused, complete, cancelled

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 List Bulk Action Campaigns — response body

Referenced models: List Bulk Action Campaigns — response body

Schemas

List Bulk Action Campaigns — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaigns	array	Required within parent	List of bulk action campaigns
campaigns[]	Model	Each item	Expand List Bulk Action Campaigns — response body — campaigns item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total count of bulk action campaigns
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID of the request

Referenced models: List Bulk Action Campaigns — response body — campaigns item

List Bulk Action Campaigns — response body — campaigns item

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Optional	Processing completion timestamp
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Required within parent	Whether the campaign is deleted
emailMetadata	JSON	Optional	Email metadata
emailMetadata (allOf 1)	Model	All variants apply	Expand List Bulk Action Campaigns — response body — campaigns item email Metadata from, name, subject, template Id
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
scheduleType	string	Optional	Schedule type (NOW, SCHEDULED, or DRIP) Known values: NOW, SCHEDULED, DRIP
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Required within parent	Campaign status Known values: processing, scheduled, paused, complete, cancelled
updatedAt	string	Required within parent	Last updated timestamp

Referenced models: List Bulk Action Campaigns — response body — campaigns item email Metadata from, name, subject, template Id

List Bulk Action Campaigns — response body — campaigns item email Metadata from, name, subject, template Id

Field	Type	Presence	Description and constraints
$	object	Root
from	string	Optional	Sender (name and email)
name	string	Optional	Sender name
subject	string	Optional	Email subject line
templateId	string	Optional	Email template ID

Policy, approvals and errors

SDK function policy ID: gohighlevel.list_bulk_action_campaigns. Catalog operation: list-bulk-action-campaigns. 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