A valid request URL is required to generate request examples{
"success": true,
"data": {
"suppressions": [
{
"phoneNumber": "+14155559999",
"reason": "Customer replied STOP",
"source": "stop",
"arrivedOn": "+14155550100",
"createdAt": "2026-07-11T08:00:00.000Z"
}
],
"total": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}List opted-out (do-not-text) contacts
List the org-wide opt-out (suppression) list — the numbers you must NOT text — with paging and phone-substring search. Use this when… you specifically want the opt-out subset (and to add/remove entries via addSMSSuppression / removeSMSSuppression). To see ALL contacts with their consent tier (opted-out or not), use listSMSContacts instead; suppressions are just the opted-out slice of that fuller consent dashboard.
A valid request URL is required to generate request examples{
"success": true,
"data": {
"suppressions": [
{
"phoneNumber": "+14155559999",
"reason": "Customer replied STOP",
"source": "stop",
"arrivedOn": "+14155550100",
"createdAt": "2026-07-11T08:00:00.000Z"
}
],
"total": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
- Token URL
- /api/v1/api-keys
Query Parameters
Filter by phone-number substring.
1-based page number for offset pagination. Defaults to 1 (the first page).
x >= 1Page size — how many items to return per page (1–100). Defaults to 20.
1 <= x <= 100