List SMS opt-outs

GET

/api/v2/opt-outs

curl --request GET \
  --url 'https://api.sipstack.com/api/v2/opt-outs?since=2026-10-01T00%3A00%3A00Z&limit=100' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sipstack.com/api/v2/opt-outs"

querystring = {"since":"2026-10-01T00:00:00Z","limit":"100"}

headers = {"x-api-key": "<x-api-key>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

const url = 'https://api.sipstack.com/api/v2/opt-outs?since=2026-10-01T00%3A00%3A00Z&limit=100';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/v2/opt-outs',
  params: {since: '2026-10-01T00:00:00Z', limit: '100'},
  headers: {'x-api-key': '<x-api-key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Returns your organization’s SMS opt-out list — one row per suppressed phone number (not per contact), ordered by updated_at ascending. Use it to keep a CRM or your own suppression list in sync. Requires the contacts:read scope and the same Flare API plan and rate limit as the contacts endpoints.

Pass since to get only numbers added or changed after that timestamp, and page with next_cursor. A number that is opted back in leaves this list, so it never shows up here as a removal — subscribe to the contact.opted_in webhook or read is_opted_out on GET /api/v2/contacts?updated_since= to see opt-ins. The text of the opt-out message is never returned.

Authorizations

apiKeyAuth

Parameters

Query Parameters

since

string format: date-time

ISO-8601 timestamp. Return only numbers added or changed after it. An unparseable date returns 400.

Example

2026-10-01T00:00:00Z

limit

integer

default: 100 >= 1 <= 500

cursor

string

Opaque keyset cursor from a previous response’s next_cursor.

Responses

200

A page of opt-outs, oldest change first.

application/json

object

success

boolean

data

Array<object>

One phone number on your organization’s SMS opt-out list.

object

phone_number

The opted-out number (E.164).

string

method

How the number was opted out.

string

Allowed values: sms web admin crm

opted_out_at

When the number was first added to the list.

string format: date-time

updated_at

When the entry last changed — the field since filters on.

string format: date-time

pagination

object

limit

integer

next_cursor

Pass as cursor to fetch the next page; null on the last page.

string

nullable

Example

{
  "success": true,
  "data": [
    {
      "phone_number": "+14165550100",
      "method": "sms"
    }
  ],
  "pagination": {
    "limit": 100
  }
}

400

Invalid since date or cursor.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

403

The key is missing the contacts:read scope, or the plan does not include Flare API access.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

429

Rate limit exceeded.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

500

Internal error.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}