Get per-channel frequency-cap status for a contact
curl --request GET \
--url https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status', 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.orbit.devotel.io/api/v1/contacts/{id}/cap-status",
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.orbit.devotel.io/api/v1/contacts/{id}/cap-status"
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.orbit.devotel.io/api/v1/contacts/{id}/cap-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status")
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": {
"contact_id": "contact_01HZX8Y7QJK4M",
"requested_channels": [
"sms",
"email"
],
"channels": {
"sms": {
"recipient": "+14155552671",
"identifier_present": true,
"consent_state": "opted_in",
"cache_degraded": false,
"slots": [
{
"cap_id": "cap_01HZX8",
"scope": "channel",
"channel": "sms",
"window_seconds": 86400,
"max_count": 3,
"current_count": 1,
"sends_remaining": 2,
"applies_to_categories": [
"marketing"
],
"next_slot_at": null
}
]
},
"email": {
"recipient": "jane@example.com",
"identifier_present": true,
"consent_state": "unknown",
"cache_degraded": false,
"slots": []
}
},
"cache_degraded": false,
"generated_at": "2026-02-02T12:00:00.000Z"
},
"meta": {
"request_id": "req_01HZX9MNOPQR",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}Contacts
Get per-channel frequency-cap status for a contact
Return a per-channel frequency-cap snapshot for a contact so the composer can show how many sends remain before the operator hits Send, instead of discovering the cap from a 429 afterwards. For each requested channel it reports whether an addressable identifier exists, the contact’s consent state, and every cap that applies with its window, max count, current in-window count, sends remaining and the next time a slot re-opens. Pass ?channels=sms,email,voice to scope the read; omit it to read every supported channel.
GET
/
api
/
v1
/
contacts
/
{id}
/
cap-status
Get per-channel frequency-cap status for a contact
curl --request GET \
--url https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status', 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.orbit.devotel.io/api/v1/contacts/{id}/cap-status",
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.orbit.devotel.io/api/v1/contacts/{id}/cap-status"
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.orbit.devotel.io/api/v1/contacts/{id}/cap-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/{id}/cap-status")
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": {
"contact_id": "contact_01HZX8Y7QJK4M",
"requested_channels": [
"sms",
"email"
],
"channels": {
"sms": {
"recipient": "+14155552671",
"identifier_present": true,
"consent_state": "opted_in",
"cache_degraded": false,
"slots": [
{
"cap_id": "cap_01HZX8",
"scope": "channel",
"channel": "sms",
"window_seconds": 86400,
"max_count": 3,
"current_count": 1,
"sends_remaining": 2,
"applies_to_categories": [
"marketing"
],
"next_slot_at": null
}
]
},
"email": {
"recipient": "jane@example.com",
"identifier_present": true,
"consent_state": "unknown",
"cache_degraded": false,
"slots": []
}
},
"cache_degraded": false,
"generated_at": "2026-02-02T12:00:00.000Z"
},
"meta": {
"request_id": "req_01HZX9MNOPQR",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Query Parameters
Optional CSV of channels to scope the read (e.g. sms,email,voice). Defaults to all supported channels.
⌘I