Get Outbound
curl --request GET \
--url https://app.pixie.ai/api/campaigns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.pixie.ai/api/campaigns/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.pixie.ai/api/campaigns/{id}', 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://app.pixie.ai/api/campaigns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.pixie.ai/api/campaigns/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.pixie.ai/api/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pixie.ai/api/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"campaignUrl": "<string>",
"campaign": {
"id": "<string>",
"user_id": "<string>",
"type": "linkedin",
"name": "<string>",
"status": "draft",
"daily_limit": 4503599627370495,
"stop_on_reply": true,
"open_tracking": true,
"signature": "<string>",
"skip_other_campaigns": true,
"operating_hours": {},
"stats": {
"total": 4503599627370495,
"sent": 4503599627370495,
"replied": 4503599627370495,
"bounced": 4503599627370495,
"completed": 4503599627370495,
"timed_out": 4503599627370495,
"connection_sent": 4503599627370495,
"connected": 4503599627370495,
"message_sent": 4503599627370495
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sender_accounts": [
{
"id": "<string>",
"type": "linkedin",
"email_address": "<string>",
"provider_account_id": "<string>",
"display_name": "<string>",
"status": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"daily_limit": 4503599627370495,
"is_default_sender": true,
"weekly_connection_limit": 4503599627370495,
"weekly_message_limit": 4503599627370495,
"is_premium": true
}
]
},
"sequence_nodes": [
{
"id": "<string>",
"campaign_id": "<string>",
"position": 4503599627370495,
"type": "connection_request",
"subject": "<string>",
"body": "<string>",
"signature": "<string>",
"include_message": true,
"is_reply": true,
"delay_days": 4503599627370495,
"delay_hours": 4503599627370495,
"delay_minutes": 4503599627370495,
"ai_node": {
"output_type": "email"
}
}
],
"sequence_edges": [
{
"from_node_id": "<string>",
"to_node_id": "<string>",
"outcome": "next",
"id": "<string>",
"campaign_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"prospects_by_status": {},
"prospects_by_node": {},
"campaign_total_sent": 4503599627370495,
"campaign_total_connections_sent": 4503599627370495,
"campaign_total_connections_accepted": 4503599627370495
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Outbound
Get Outbound
Get one campaign-backed Outbound execution
GET
/
api
/
campaigns
/
{id}
Get Outbound
curl --request GET \
--url https://app.pixie.ai/api/campaigns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.pixie.ai/api/campaigns/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.pixie.ai/api/campaigns/{id}', 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://app.pixie.ai/api/campaigns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.pixie.ai/api/campaigns/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.pixie.ai/api/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pixie.ai/api/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"campaignUrl": "<string>",
"campaign": {
"id": "<string>",
"user_id": "<string>",
"type": "linkedin",
"name": "<string>",
"status": "draft",
"daily_limit": 4503599627370495,
"stop_on_reply": true,
"open_tracking": true,
"signature": "<string>",
"skip_other_campaigns": true,
"operating_hours": {},
"stats": {
"total": 4503599627370495,
"sent": 4503599627370495,
"replied": 4503599627370495,
"bounced": 4503599627370495,
"completed": 4503599627370495,
"timed_out": 4503599627370495,
"connection_sent": 4503599627370495,
"connected": 4503599627370495,
"message_sent": 4503599627370495
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sender_accounts": [
{
"id": "<string>",
"type": "linkedin",
"email_address": "<string>",
"provider_account_id": "<string>",
"display_name": "<string>",
"status": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"daily_limit": 4503599627370495,
"is_default_sender": true,
"weekly_connection_limit": 4503599627370495,
"weekly_message_limit": 4503599627370495,
"is_premium": true
}
]
},
"sequence_nodes": [
{
"id": "<string>",
"campaign_id": "<string>",
"position": 4503599627370495,
"type": "connection_request",
"subject": "<string>",
"body": "<string>",
"signature": "<string>",
"include_message": true,
"is_reply": true,
"delay_days": 4503599627370495,
"delay_hours": 4503599627370495,
"delay_minutes": 4503599627370495,
"ai_node": {
"output_type": "email"
}
}
],
"sequence_edges": [
{
"from_node_id": "<string>",
"to_node_id": "<string>",
"outcome": "next",
"id": "<string>",
"campaign_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"prospects_by_status": {},
"prospects_by_node": {},
"campaign_total_sent": 4503599627370495,
"campaign_total_connections_sent": 4503599627370495,
"campaign_total_connections_accepted": 4503599627370495
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}CLI:
pixie campaign --id <id>
Overview
Returns one campaign-backed Outbound execution owned by the caller, including lifecycle status, configured sequence, flattened sender accounts, stats, and contact aggregates for the detail view. Use this after List Outbound when you need the full row shape instead of the compact index row.AI agent notes
Checkstatus before deciding what actions are allowed. Draft Outbound rows can be edited; active and paused rows have narrower update behavior; completed rows are effectively historical.
For contact rows, generated messages, sender attribution, or settings, prefer the specific child endpoints when you need a fresh focused view.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Campaign UUID
Response
Outbound detail with sequence and contact aggregates.
Canonical campaign entity.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Cumulative direct messages or emails for this campaign. LinkedIn connection-request notes are counted as connections, not messages.
Required range:
0 <= x <= 9007199254740991Cumulative LinkedIn connection requests sent by this campaign.
Required range:
0 <= x <= 9007199254740991Cumulative LinkedIn connection requests accepted in this campaign.
Required range:
0 <= x <= 9007199254740991Was this page helpful?