cURL
curl --request GET \
--url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign \
--header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign', 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.teamfollowup.ai/api/agent-builder/agents/{id}/campaign",
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.teamfollowup.ai/api/agent-builder/agents/{id}/campaign"
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.teamfollowup.ai/api/agent-builder/agents/{id}/campaign")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign")
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{
"success": true,
"campaign": {
"id": "cmp_9f7a123",
"name": "Roofing Follow Up",
"description": null,
"agentId": "agent_8a488fcfa8fdbf8ce8ad5ccc45",
"active": false,
"locationId": "loc_9f7a123",
"projectId": "64f2a8c8a2b3c4d5e6f7a8b9",
"campaignType": "outbound",
"trigger": {
"type": "outbound",
"activeTags": [
"hot lead"
],
"inactiveTags": [
"booked"
]
},
"capabilities": {},
"tools": {},
"calling": {
"s2lDoubleDial": false
},
"testing": {
"collectContextFields": false
},
"fromNumbers": [
"+14155550100"
],
"masterCampaignEnabled": false,
"metadata": {},
"createdAt": "2026-09-01T09:00:00.000Z",
"updatedAt": "2026-09-17T09:00:00.000Z",
"outcomes": {}
}
}{
"success": false,
"error": "VALIDATION",
"code": "VALIDATION",
"message": "A shared agent needs locationId and campaignId together."
}{
"success": false,
"error": "UNAUTHORIZED",
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}{
"success": false,
"error": "FORBIDDEN",
"code": "FORBIDDEN",
"message": "campaigns:read scope is required."
}{
"success": false,
"error": "NOT_FOUND",
"code": "NOT_FOUND",
"message": "Campaign not found."
}{
"success": false,
"error": "Unauthorized",
"message": "Authentication required."
}{
"success": false,
"error": "INTERNAL_ERROR",
"code": "INTERNAL_ERROR",
"message": "Campaign settings could not be read."
}Get campaign
Read the campaign bound to this agent, grouped into trigger, capabilities, tools, calling and outcomes. Outbound/inbound booking calendars belong to capabilities.appointment_booking; confirmation calendars belong to trigger. Only installed abilities are listed, with their inventory version and freshness. A shared agent may belong to several campaigns: provide locationId and campaignId together to choose one. Calendar administration lives in your connected CRM. Required scope: campaigns:read.
Required API key scope: campaigns:read.
GET
/
api
/
agent-builder
/
agents
/
{id}
/
campaign
cURL
curl --request GET \
--url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign \
--header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign', 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.teamfollowup.ai/api/agent-builder/agents/{id}/campaign",
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.teamfollowup.ai/api/agent-builder/agents/{id}/campaign"
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.teamfollowup.ai/api/agent-builder/agents/{id}/campaign")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign")
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{
"success": true,
"campaign": {
"id": "cmp_9f7a123",
"name": "Roofing Follow Up",
"description": null,
"agentId": "agent_8a488fcfa8fdbf8ce8ad5ccc45",
"active": false,
"locationId": "loc_9f7a123",
"projectId": "64f2a8c8a2b3c4d5e6f7a8b9",
"campaignType": "outbound",
"trigger": {
"type": "outbound",
"activeTags": [
"hot lead"
],
"inactiveTags": [
"booked"
]
},
"capabilities": {},
"tools": {},
"calling": {
"s2lDoubleDial": false
},
"testing": {
"collectContextFields": false
},
"fromNumbers": [
"+14155550100"
],
"masterCampaignEnabled": false,
"metadata": {},
"createdAt": "2026-09-01T09:00:00.000Z",
"updatedAt": "2026-09-17T09:00:00.000Z",
"outcomes": {}
}
}{
"success": false,
"error": "VALIDATION",
"code": "VALIDATION",
"message": "A shared agent needs locationId and campaignId together."
}{
"success": false,
"error": "UNAUTHORIZED",
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}{
"success": false,
"error": "FORBIDDEN",
"code": "FORBIDDEN",
"message": "campaigns:read scope is required."
}{
"success": false,
"error": "NOT_FOUND",
"code": "NOT_FOUND",
"message": "Campaign not found."
}{
"success": false,
"error": "Unauthorized",
"message": "Authentication required."
}{
"success": false,
"error": "INTERNAL_ERROR",
"code": "INTERNAL_ERROR",
"message": "Campaign settings could not be read."
}Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Path Parameters
The agent ID bound to the campaign.
Query Parameters
Project location ID; provide with campaignId for a shared agent.
Campaign ID; provide with locationId for a shared agent.
⌘I
