Messaging · SMS
Returns SMS opt-outs, one page at a time.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the contacts resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
format | string | One of json, csvDefault json |
limit | integer | Default 5001 to 5000 |
Example
curl -X GET "https://api.pozy.ai/v1/sms/opt-outs?limit=500" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/sms/opt-outs?limit=500", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/sms/opt-outs",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 500,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
optOutsarray of objectphoneNumberstringoptedOutAtstring (date-time)Can be null.
keywordstringCan be null.
fromstringCan be null.
countinteger
200 response
{
"optOuts": [
{
"phoneNumber": "+14155550123",
"optedOutAt": "2026-10-02T09:00:00.000Z",
"keyword": "string",
"from": "+14155550123"
}
],
"count": 42
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in SMS
POSTSend an SMS/MMSGETLook up carrier + line typeGETList alphanumeric sender IDsPOSTCreate an alphanumeric sender IDPOSTRequest a higher sender ID daily limitDELDelete an alphanumeric sender IDGETList carrier registrationsPOSTStart a carrier registrationPOSTPre-check a carrier registrationGETGet a carrier registrationDELDeactivate a brand/campaign registrationPOSTSubmit the sole-prop OTPPOSTRe-send the sole-prop OTPPOSTAppeal a rejected campaignPOSTReply to a change requestPOSTUpload opt-in form proofPOSTUpload opt-in form proof for an appealPOSTCreate a registration share linkPOSTEnable SMS on a numberDELDisable SMS on a numberPOSTAdd number to SMS registration