List the recipients materialized for this campaign, including per-recipient
curl --request GET \
--url https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients"
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}/recipients', 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}/recipients",
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}/recipients"
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))
}HttpResponse<String> response = Unirest.get("https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients")
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{
"items": [
{
"id": "<string>",
"campaignId": "<string>",
"listRowId": "<string>",
"email": "<string>",
"status": "<string>",
"sentAt": "<string>",
"errorMessage": "<string>",
"opened": true,
"firstOpenedDate": "<string>",
"lastOpenedDate": "<string>",
"openCount": 123,
"clicked": true,
"firstClickedDate": "<string>",
"lastClickedDate": "<string>",
"clickCount": 123,
"created_date": "<string>",
"updated_date": "<string>"
}
],
"total": 123,
"metrics": {
"total": 123,
"sent": 123,
"failed": 123,
"skipped": 123,
"opened": 123,
"clicked": 123,
"openRate": 123,
"clickRate": 123
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Marketing Campaigns
List the recipients materialized for this campaign, including per-recipient
send status, open count, click count, and error message where applicable.
Recipients are created when a campaign starts sending; for draft or scheduled
campaigns this list will usually be empty.
Optionally pass ?search=<text> to filter the returned items to recipients
whose email address contains the given substring (case-insensitive). The
aggregate metrics object always reflects all recipients for the campaign,
independent of the search filter.
GET
/
api
/
v0
/
marketing-campaigns
/
{campaignId}
/
recipients
List the recipients materialized for this campaign, including per-recipient
curl --request GET \
--url https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients"
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}/recipients', 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}/recipients",
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}/recipients"
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))
}HttpResponse<String> response = Unirest.get("https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/marketing-campaigns/{campaignId}/recipients")
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{
"items": [
{
"id": "<string>",
"campaignId": "<string>",
"listRowId": "<string>",
"email": "<string>",
"status": "<string>",
"sentAt": "<string>",
"errorMessage": "<string>",
"opened": true,
"firstOpenedDate": "<string>",
"lastOpenedDate": "<string>",
"openCount": 123,
"clicked": true,
"firstClickedDate": "<string>",
"lastClickedDate": "<string>",
"clickCount": 123,
"created_date": "<string>",
"updated_date": "<string>"
}
],
"total": 123,
"metrics": {
"total": 123,
"sent": 123,
"failed": 123,
"skipped": 123,
"opened": 123,
"clicked": 123,
"openRate": 123,
"clickRate": 123
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
CompanyApiKeyBearerAuth & CompanyId
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Path Parameters
Query Parameters
Case-insensitive substring filter applied to the recipient email address
1-indexed page; omit for legacy unpaginated results
Page size, 1-100, default 25
Response
All recipient rows for this campaign, ordered most-recent first. Pass ?search= to filter by email substring.

