Get a single marketing campaign by ID.

curl --request GET \
  --url https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "companyId": "<string>",
  "uid": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "fromName": "<string>",
  "replyTo": "<string>",
  "bodyHtml": "<string>",
  "bodyDocument": "<string>",
  "senderProfileId": "<string>",
  "listId": "<string>",
  "fieldMappings": {},
  "scheduleType": "<string>",
  "scheduledAt": "<string>",
  "timezone": "<string>",
  "status": "<string>",
  "sentCount": 123,
  "failedCount": 123,
  "skippedCount": 123,
  "totalRecipients": 123,
  "startedAt": "<string>",
  "completedAt": "<string>",
  "created_date": "<string>",
  "updated_date": "<string>",
  "smartList": {
    "id": "<string>",
    "name": "<string>"
  },
  "senderProfile": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "integrationId": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

api

marketing-campaigns

{campaignId}

Get a single marketing campaign by ID.

curl --request GET \
  --url https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "companyId": "<string>",
  "uid": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "fromName": "<string>",
  "replyTo": "<string>",
  "bodyHtml": "<string>",
  "bodyDocument": "<string>",
  "senderProfileId": "<string>",
  "listId": "<string>",
  "fieldMappings": {},
  "scheduleType": "<string>",
  "scheduledAt": "<string>",
  "timezone": "<string>",
  "status": "<string>",
  "sentCount": 123,
  "failedCount": 123,
  "skippedCount": 123,
  "totalRecipients": 123,
  "startedAt": "<string>",
  "completedAt": "<string>",
  "created_date": "<string>",
  "updated_date": "<string>",
  "smartList": {
    "id": "<string>",
    "name": "<string>"
  },
  "senderProfile": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "integrationId": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-Key

string

header

required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

campaignId

string

required

Response

The requested marketing campaign

Marketing campaign object

string

Campaign ID

companyId

string

Company this campaign belongs to

uid

string

User ID that created the campaign

name

string

Internal campaign name

subject

string

Email subject line

fromName

string

Display name shown in the From: header

replyTo

string

Reply-To email address used on outgoing emails

bodyHtml

string

HTML body of the email; rendered from bodyDocument when a document is supplied

bodyDocument

string

Visual-builder JSON document for the email body. When supplied, the server renders bodyHtml from this document and it takes precedence over HTML input. Alternatively, supply bodyHtml without a document. Envelope: {"subject": string, "subTitle": string, "content": }. Every node is {"type": string, "attributes": {MJML attributes as string values, e.g. "padding": "10px 25px 10px 25px", "background-color": "#ffffff", "color": "#333333", "font-size": "16px", "align": "center", "width": "600px", "href", "src"}, "data": {"value": {...}}, "children": [...]}; attribute values must be strings (numbers are dropped). Tree: page -> (wrapper | section) -> section -> column -> content blocks. Content block types: "text" (data.value.content = inline HTML string), "image" (attributes.src, alt, href, width), "button" (data.value.content = label, attributes.href), "divider", "spacer" (attributes.height), "social" (data.value.elements = [{src, href, content, target}]), "navbar" (data.value.links = [{href, content}]), "raw" (data.value.content = raw MJML/HTML), plus "hero", "group", "accordion", "carousel" and "table". Each also has an "advanced_" variant (e.g. "advanced_text"), which is what the builder palette inserts; advanced content blocks placed directly under the page or a wrapper are auto-wrapped in a section/column. Page node: {"type": "page", "attributes": {"background-color": "#efeeea", "width": "600px"}, "data": {"value": {"breakpoint": "480px", "font-family": string, "font-size": "14px", "line-height": "1.7", "font-weight": "400", "text-color": "#000000", "content-background-color": string (optional), "headStyles": [{"content": css, "inline": bool}], "fonts": [{"name", "href"}], "headAttributes": "", "responsive": true}}}. Always set "responsive": true — a missing flag renders a fixed-width layout. Merge tokens pass through rendering untouched: {{content}} inside a text block marks where content-engine output is inserted when content is published as a campaign from this template; {{variableName}} tokens (e.g. {{First Name}}) are replaced per recipient from the smart-list row; {{unsubscribe}} becomes the per-recipient unsubscribe link.

senderProfileId

string

Sender profile ID

listId

string

Smart list ID whose rows become recipients

fieldMappings

object

Field mapping for resolving recipient email from a list row

scheduleType

string

Schedule type (now, scheduled)

scheduledAt

string

ISO timestamp at which sending begins (for scheduled campaigns)

timezone

string

IANA timezone used to interpret scheduledAt

status

string

Campaign status (draft, scheduled, sending, sent, failed, cancelled)

sentCount

integer

Number of recipients the email has been sent to

failedCount

integer

Number of recipients that failed to send

skippedCount

integer

Number of list rows skipped (missing email, duplicate, etc.)

totalRecipients

integer

Total rows in the associated smart list at read time

startedAt

string

ISO timestamp when sending started

completedAt

string

ISO timestamp when sending completed

created_date

string

ISO timestamp when the campaign was created

updated_date

string

ISO timestamp when the campaign was last updated

smartList

object

Summary of the associated smart list

Show child attributes

senderProfile

object

Summary of the sender profile

Show child attributes