Get per-date SMS usage and campaign breakdown
curl --request GET \
--url https://your-instance.example.com/api/campaigns/usage-calendar \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/campaigns/usage-calendar"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/campaigns/usage-calendar', 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://your-instance.example.com/api/campaigns/usage-calendar",
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://your-instance.example.com/api/campaigns/usage-calendar"
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://your-instance.example.com/api/campaigns/usage-calendar")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/usage-calendar")
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,
"data": {
"timezone": "America/Toronto",
"dailyLimit": 500,
"isUnlimited": false,
"plan": "growth",
"dates": {
"2026-05-20": {
"sent": 0,
"reserved": 100,
"total": 100,
"availableQuota": 400,
"campaigns": [
{
"campaignId": "665f1a0c0e0a4b001a2c9f10",
"campaignName": "Q2 Lead Gen",
"contactCount": 100,
"status": "scheduled"
}
]
}
}
}
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Campaigns
Get per-date SMS usage and campaign breakdown
Returns SMS usage (sent + reserved) and the list of scheduled/sent campaigns per organization-local date within the requested range. Used by the Campaigns overview calendar.
GET
/
api
/
campaigns
/
usage-calendar
Get per-date SMS usage and campaign breakdown
curl --request GET \
--url https://your-instance.example.com/api/campaigns/usage-calendar \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/campaigns/usage-calendar"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/campaigns/usage-calendar', 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://your-instance.example.com/api/campaigns/usage-calendar",
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://your-instance.example.com/api/campaigns/usage-calendar"
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://your-instance.example.com/api/campaigns/usage-calendar")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/usage-calendar")
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,
"data": {
"timezone": "America/Toronto",
"dailyLimit": 500,
"isUnlimited": false,
"plan": "growth",
"dates": {
"2026-05-20": {
"sent": 0,
"reserved": 100,
"total": 100,
"availableQuota": 400,
"campaigns": [
{
"campaignId": "665f1a0c0e0a4b001a2c9f10",
"campaignName": "Q2 Lead Gen",
"contactCount": 100,
"status": "scheduled"
}
]
}
}
}
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Inclusive start date (YYYY-MM-DD, org-local timezone).
Inclusive end date (YYYY-MM-DD, org-local timezone).
⌘I