List opted-out numbers (suppression list)

GET /v1/consent

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Query parameters

Name	Type	Required	Description
`limit`	integer	No	Default 25. Maximum 100.
`cursor`	string	No

Results are paged. When has_more is true, pass next_cursor from the response as cursor to fetch the next page.

Responses

Status	Meaning	Body
200	Suppressions in numeric order	Page of `Consent`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: each item in `data` (Consent)

The body is a page: data (the array), has_more, and next_cursor (null on the last page).

Field	Type	Description
`object`	`consent`
`phone`	string	Example: `+14155550132`.
`status`	`opted_out`, `opted_in`, `no_record`
`updated_at`	string (date-time)
`via`	string	Example: `sms_phrase`.
`method`	`keyword`, `phrase`, `ai`, `api`, `import`
`detected`	string	The keyword or phrase that triggered detection
`confidence`	number	AI-tier detections only, 0 to 1

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/consent?limit=10" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const optedOut = await sms.consent.list({ limit: 10 });

console.log(optedOut.data.map((c) => c.phone));

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

opted_out = client.consent.list(limit=10)

print([c["phone"] for c in opted_out["data"]])