Skip to main content
GET
/
api
/
v1
/
campaigns
/
List Campaigns
curl --request GET \
  --url https://api.example.com/api/v1/campaigns/ \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/campaigns/"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/campaigns/', 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/api/v1/campaigns/",
  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://api.example.com/api/v1/campaigns/"

	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://api.example.com/api/v1/campaigns/")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaigns/")

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
{
  "campaigns": [
    {
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "daily_limit": 123,
      "sending_window_start": "<string>",
      "sending_window_end": "<string>",
      "min_interval_seconds": 123,
      "timezone": "<string>",
      "steps_config": [
        {
          "step": 2,
          "delay_days": 1,
          "channel": "email",
          "variants": [
            {
              "label": "<string>",
              "weight": 50,
              "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sender_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "ai_personalization_enabled": true,
          "track_clicks": false,
          "message_template": "<string>"
        }
      ],
      "send_days": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "alias_ids": [
        "<string>"
      ],
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_leads": 123,
      "processed_leads": 0,
      "launch_job_id": "<string>",
      "launch_requested_at": "2023-11-07T05:31:56Z",
      "launch_error": "<string>",
      "system_prompt": "<string>",
      "unreviewed_launch_policy": "launch_default",
      "paused_reason": "<string>",
      "playground_discovery_dismissed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string> | null

Campaign status values.

Available options:
draft,
launching,
scheduled,
active,
draining,
paused,
completed,
failed
search
string | null

Search by campaign name

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Successful Response

Response model for campaign list.

campaigns
CampaignResponse · object[]
required

List of campaigns

total
integer
required

Total number of campaigns

page
integer
required

Current page number

page_size
integer
required

Items per page