Book a demo

Get Campaign

emelia.get_campaign
ActionEmailconnection required

Calls the Emelia API with the connection's credentials.

Read one campaign's full configuration, including its attached lists.

Ask about EmeliaAll Emelia nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Emelia
Secret shape
the API key, or {"api_key": "…"}
Config it needs
list_id
Resolved by
config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
campaign_id
The campaign's Emelia id, as returned by emelia.create_campaign or list_campaigns.
stringYes——65f0a1b2c3d4e5f6a7b8c9d0

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "campaign_id": "65f0a1b2c3d4e5f6a7b8c9d0"
}

Output

One shape.

result

FieldTypeExample
_id
The campaign's Emelia id.
string—
name
Name of the campaign.
string—
status
DRAFT, RUNNING, PAUSED, FINISHED or ARCHIVED.
string—
identities
The senders the campaign sends as.
array—
schedule
Daily cadence, sending window, tracking and stop events.
object—
steps
The campaign sequence, as a chain of steps.
object—
recipients.lists
Contact lists attached to the campaign.
array—
recipients.excludedLists
Contact lists excluded from the campaign.
array—
recipients.processing
True while the recipients are being recomputed.
boolean—
createdAt
When the campaign was created, as an ISO-8601 timestamp.
string—
startAt
When the campaign started, as an ISO-8601 timestamp.
string—
plannedStart
When the campaign is scheduled to start, when it is.
string—
{
  "_id": "",
  "createdAt": "",
  "identities": [],
  "name": "",
  "plannedStart": "",
  "recipients": {
    "excludedLists": [],
    "lists": [],
    "processing": false
  },
  "schedule": {},
  "startAt": "",
  "status": "",
  "steps": {}
}

Related Emelia nodes

See Get Campaign run in a workflow.

In a technical demo we add the Emelia connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales