List campaigns
curl --request GET \
--url https://app.heyfred.nl/api/user/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.heyfred.nl/api/user/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.heyfred.nl/api/user/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://app.heyfred.nl/api/user/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://app.heyfred.nl/api/user/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://app.heyfred.nl/api/user/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.heyfred.nl/api/user/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[
{
"id": 1,
"name": "Product Demo Campaign",
"channel": "call",
"status": "in-progress",
"assistant_id": 42,
"timezone": "Europe/Bucharest",
"max_calls_in_parallel": 3,
"messages_per_minute": null,
"schedule_windows": [{ "start": "09:00", "end": "18:00" }],
"scheduled_start_at": null,
"allowed_hours_start_time": "09:00:00",
"allowed_hours_end_time": "18:00:00",
"allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
"max_retries": 3,
"retry_interval": 60,
"retry_on_voicemail": false,
"retry_on_goal_incomplete": false,
"goal_completion_variable": null,
"mark_complete_when_no_leads": true,
"phone_number_ids": [11],
"whatsapp_sender_id": null,
"whatsapp_template_id": null,
"sms_from_phone_number_id": null,
"sms_body": null,
"text_variable_mapping": null,
"fallback_channel": "whatsapp",
"fallback_whatsapp_sender_id": 7,
"fallback_whatsapp_template_id": 15,
"fallback_sms_from_phone_number_id": null,
"fallback_sms_body": null,
"fallback_variable_mapping": { "1": "customer_name" },
"created_at": "2026-07-24 10:00:00",
"updated_at": "2026-07-24 12:00:00"
},
{
"id": 2,
"name": "WhatsApp Follow-up",
"channel": "whatsapp",
"status": "draft",
"assistant_id": null,
"messages_per_minute": 10,
"schedule_windows": [{ "start": "09:00", "end": "20:00" }],
"whatsapp_sender_id": 7,
"whatsapp_template_id": 15,
"text_variable_mapping": { "1": "customer_name" },
"fallback_channel": null
}
]
Campaigns
List campaigns
List all campaigns (call, WhatsApp, SMS)
GET
/
user
/
campaigns
List campaigns
curl --request GET \
--url https://app.heyfred.nl/api/user/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.heyfred.nl/api/user/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.heyfred.nl/api/user/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://app.heyfred.nl/api/user/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://app.heyfred.nl/api/user/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://app.heyfred.nl/api/user/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.heyfred.nl/api/user/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[
{
"id": 1,
"name": "Product Demo Campaign",
"channel": "call",
"status": "in-progress",
"assistant_id": 42,
"timezone": "Europe/Bucharest",
"max_calls_in_parallel": 3,
"messages_per_minute": null,
"schedule_windows": [{ "start": "09:00", "end": "18:00" }],
"scheduled_start_at": null,
"allowed_hours_start_time": "09:00:00",
"allowed_hours_end_time": "18:00:00",
"allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
"max_retries": 3,
"retry_interval": 60,
"retry_on_voicemail": false,
"retry_on_goal_incomplete": false,
"goal_completion_variable": null,
"mark_complete_when_no_leads": true,
"phone_number_ids": [11],
"whatsapp_sender_id": null,
"whatsapp_template_id": null,
"sms_from_phone_number_id": null,
"sms_body": null,
"text_variable_mapping": null,
"fallback_channel": "whatsapp",
"fallback_whatsapp_sender_id": 7,
"fallback_whatsapp_template_id": 15,
"fallback_sms_from_phone_number_id": null,
"fallback_sms_body": null,
"fallback_variable_mapping": { "1": "customer_name" },
"created_at": "2026-07-24 10:00:00",
"updated_at": "2026-07-24 12:00:00"
},
{
"id": 2,
"name": "WhatsApp Follow-up",
"channel": "whatsapp",
"status": "draft",
"assistant_id": null,
"messages_per_minute": 10,
"schedule_windows": [{ "start": "09:00", "end": "20:00" }],
"whatsapp_sender_id": 7,
"whatsapp_template_id": 15,
"text_variable_mapping": { "1": "customer_name" },
"fallback_channel": null
}
]
Returns every campaign you own, including channel, schedule windows, WhatsApp/SMS config, and optional call→text fallback settings.
Response
Returns a JSON array of campaign objects.integer
Campaign ID
string
Campaign name
string
call, whatsapp, or smsstring
e.g.
draft, scheduled, in-progress, paused, completedinteger
OUTBOUND assistant ID (call campaigns).
null for text campaigns.string
IANA timezone for the send/call window
integer
Concurrent call slots (call campaigns)
integer
Per-campaign text send rate (WhatsApp/SMS). WhatsApp also uses a user-wide in-flight pool of 10.
array
Daily windows
[{ "start": "HH:MM", "end": "HH:MM" }]. Overnight allowed when end < start.string
ISO datetime for auto-start, or
nullstring
Legacy window start (kept in sync with the first schedule window)
string
Legacy window end
array
Weekdays when sending/calling is allowed
integer
Max retries per lead
integer
Minutes between retries
boolean
Call campaigns: retry on voicemail
boolean
Call campaigns: retry until goal variable is true
string
Boolean post-call variable name, or
nullboolean
Auto-complete when no work remains
array
Outbound from-number IDs (call campaigns)
integer
WhatsApp sender ID, or
nullinteger
WhatsApp template ID, or
nullinteger
SMS from-number ID, or
nullstring
SMS body, or
nullobject
WhatsApp template placeholder → lead variable map, or
nullstring
Call→text fallback channel (
whatsapp / sms), or nullinteger
Fallback WhatsApp sender, or
nullinteger
Fallback WhatsApp template, or
nullinteger
Fallback SMS from-number, or
nullstring
Fallback SMS body, or
nullobject
Fallback WhatsApp variable map, or
nullstring
Created timestamp in your account timezone
string
Updated timestamp in your account timezone
[
{
"id": 1,
"name": "Product Demo Campaign",
"channel": "call",
"status": "in-progress",
"assistant_id": 42,
"timezone": "Europe/Bucharest",
"max_calls_in_parallel": 3,
"messages_per_minute": null,
"schedule_windows": [{ "start": "09:00", "end": "18:00" }],
"scheduled_start_at": null,
"allowed_hours_start_time": "09:00:00",
"allowed_hours_end_time": "18:00:00",
"allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
"max_retries": 3,
"retry_interval": 60,
"retry_on_voicemail": false,
"retry_on_goal_incomplete": false,
"goal_completion_variable": null,
"mark_complete_when_no_leads": true,
"phone_number_ids": [11],
"whatsapp_sender_id": null,
"whatsapp_template_id": null,
"sms_from_phone_number_id": null,
"sms_body": null,
"text_variable_mapping": null,
"fallback_channel": "whatsapp",
"fallback_whatsapp_sender_id": 7,
"fallback_whatsapp_template_id": 15,
"fallback_sms_from_phone_number_id": null,
"fallback_sms_body": null,
"fallback_variable_mapping": { "1": "customer_name" },
"created_at": "2026-07-24 10:00:00",
"updated_at": "2026-07-24 12:00:00"
},
{
"id": 2,
"name": "WhatsApp Follow-up",
"channel": "whatsapp",
"status": "draft",
"assistant_id": null,
"messages_per_minute": 10,
"schedule_windows": [{ "start": "09:00", "end": "20:00" }],
"whatsapp_sender_id": 7,
"whatsapp_template_id": 15,
"text_variable_mapping": { "1": "customer_name" },
"fallback_channel": null
}
]

