List campaigns
curl --request GET \
--url https://api.creditor.younegotiate.com/communications/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creditor.younegotiate.com/communications/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{
"data": [
{
"id": 101,
"template_id": 10,
"group_id": 25,
"template": {
"id": 10,
"name": "Settlement EcoLetter",
"type": {
"value": "e-letter",
"label": "Eco Letter"
}
},
"group": {
"id": 25,
"name": "Delivered January Group"
},
"frequency": {
"label": "Weekly"
},
"start_date": "2026-06-21",
"end_date": "2026-09-21",
"day_of_week": 1,
"day_of_month": 15,
"terms": "Weekly on Monday",
"is_run_immediately": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
}
}{
"message": "<string>"
}{
"message": "An active membership is required."
}{
"message": "<string>",
"errors": {}
}List campaigns
List active creditor EcoLetter campaigns with search, sorting, sub-account scoping, and pagination.
GET
/
communications
/
campaigns
List campaigns
curl --request GET \
--url https://api.creditor.younegotiate.com/communications/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/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.creditor.younegotiate.com/communications/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creditor.younegotiate.com/communications/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{
"data": [
{
"id": 101,
"template_id": 10,
"group_id": 25,
"template": {
"id": 10,
"name": "Settlement EcoLetter",
"type": {
"value": "e-letter",
"label": "Eco Letter"
}
},
"group": {
"id": 25,
"name": "Delivered January Group"
},
"frequency": {
"label": "Weekly"
},
"start_date": "2026-06-21",
"end_date": "2026-09-21",
"day_of_week": 1,
"day_of_month": 15,
"terms": "Weekly on Monday",
"is_run_immediately": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
}
}{
"message": "<string>"
}{
"message": "An active membership is required."
}{
"message": "<string>",
"errors": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Search campaign frequency, template name, or group name.
Maximum string length:
255Sort field. Snake-case values are preferred; kebab-case aliases are accepted for portal compatibility.
Available options:
frequency, start_date, start-date, end_date, end-date, template_name, template-name, group_name, group-name, terms, time Sort direction.
Available options:
asc, desc Number of records per page.
Required range:
1 <= x <= 100Last modified on July 20, 2026
Was this page helpful?
⌘I

