List Campaigns
curl --request GET \
--url https://getbill.io/external-api/v1/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://getbill.io/external-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://getbill.io/external-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://getbill.io/external-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://getbill.io/external-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://getbill.io/external-api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://getbill.io/external-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_bodyCampaigns API
List Campaigns
List API-referenced campaigns for the authenticated company
GET
/
external-api
/
v1
/
campaigns
List Campaigns
curl --request GET \
--url https://getbill.io/external-api/v1/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://getbill.io/external-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://getbill.io/external-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://getbill.io/external-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://getbill.io/external-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://getbill.io/external-api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://getbill.io/external-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_bodyReturns only campaigns with an
Results are ordered by
api_reference owned by the company attached to the OAuth client. No GetBill campaign or timeline ID is exposed.
Authentication
Requiresdebts:read or debts:write.
Query parameters
integer
default:"1"
Page number, starting at 1.
integer
default:"20"
Items per page, from 1 to 100.
string
Exact match:
active, paused, or completed.string
Exact company-scoped API reference.
created_at descending, then api_reference ascending.
Request
curl "https://getbill.io/external-api/v1/campaigns?status=active&page=1&limit=20" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
200
{
"error": false,
"data": [
{
"api_reference": "client-a-2026",
"name": "Client A — 2026",
"mode": "full_sync",
"status": "active",
"configured": true,
"automated_enrichment": {
"detect_civility": false,
"validate_emails": false
},
"timeline": { "name": "Standard reminders" },
"latest_snapshot": {
"snapshot_reference": "export-2026-07-16-8f14e45f",
"status": "completed",
"updated_at": "2026-07-16T21:04:12Z"
},
"created_at": "2026-01-05T09:00:00Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 20,
"pages": 1
}
}
timeline is null when unconfigured. latest_snapshot is null before first use. All dates are UTC.
An unsupported status returns 400 with details.reason = invalid_status. Missing or cross-company resources are never included.
See Synchronize Campaign Snapshots.