Get a Campaign
curl --request GET \
--url https://api.example.com/v1/campaigns/:idimport requests
url = "https://api.example.com/v1/campaigns/:id"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/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://api.example.com/v1/campaigns/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/campaigns/:id"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/campaigns/:id")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyCampaign
Get a Campaign
Retrieves the full details of a specific campaign.
GET
/
v1
/
campaigns
/
:id
Get a Campaign
curl --request GET \
--url https://api.example.com/v1/campaigns/:idimport requests
url = "https://api.example.com/v1/campaigns/:id"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/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://api.example.com/v1/campaigns/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/campaigns/:id"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/campaigns/:id")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyGet a Campaign
Retrieves the full details of a specific campaign by its ID.Request
GET /v1/campaigns/:id
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | uuid | Yes | The unique identifier of the campaign |
Example
curl -X GET \
"https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/campaigns/c1d2e3f4-..." \
-H "Authorization: Bearer rchd_live_xxxxxxxxxxxx"
const campaignId = "c1d2e3f4-...";
const response = await fetch(
`https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/campaigns/${campaignId}`,
{
headers: {
"Authorization": "Bearer rchd_live_xxxxxxxxxxxx"
}
}
);
const { data } = await response.json();
import requests
campaign_id = "c1d2e3f4-..."
response = requests.get(
f"https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/campaigns/{campaign_id}",
headers={"Authorization": "Bearer rchd_live_xxxxxxxxxxxx"}
)
data = response.json()
Response
- 200 OK
- 404 Not Found
{
"data": {
"id": "c1d2e3f4-...",
"name": "Q1 Outbound France",
"status": "active",
"parallel_calls": 3,
"script_template": "Hi {first_name}, ...",
"tags": ["france", "q1"],
"created_at": "2026-03-01T09:00:00.000Z"
}
}
{
"error": {
"code": "not_found",
"message": "Campaign not found"
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | uuid | Campaign unique identifier |
name | string | Campaign name |
status | string | Current status |
parallel_calls | integer | Number of parallel calls configured |
script_template | string | Call script template with placeholders |
tags | array | Tags associated with the campaign |
created_at | datetime | Creation timestamp |
⌘I
.png?fit=max&auto=format&n=PYj-p9lRwfHX4QQS&q=85&s=967f00940a17d1d8cc11bd8995dc98d0)
.png?fit=max&auto=format&n=PYj-p9lRwfHX4QQS&q=85&s=5072033d90dfd5e7cc9349712ea4e145)