Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

List SMS suppressions

GET
/v1/sms/suppressions
for await (const suppression of bird.smsSuppressions.list()) {
  console.log(suppression.originator, suppression.destination, suppression.reason);
}
Response200
{
  "data": [
    {
      "id": "ssu_01krdgeqcxet5s7t44vh8rt9mg",
      "destination": "+15550001234",
      "originator": "+15557654321",
      "reason": "keyword_stop",
      "origin": "keyword",
      "applies_to": "all",
      "source_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg",
      "ended_reason": "keyword_start",
      "source_end_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the suppressions currently stopping your messages, most recent opt-out first. Pass destination to look up one subscriber before sending to them.

A suppression covers one sender and one subscriber, so the same number can appear more than once: opting out of one of your senders does not opt out of the others.

Ended suppressions are excluded. A subscriber who opted back in is reachable again and does not appear in this list.

Query Parameters

destinationstring

Return only suppressions for this exact subscriber number in E.164 form. Prefix matching is unsupported.

originatorstring

Return only suppressions covering this sender.

reasonstring

Return only suppressions with this reason:

  • keyword_stop: The subscriber texted a stop keyword to the sender.
  • carrier_opted_out: Their carrier reported the opt-out.
  • manual: Added through the API or dashboard.

Possible values: keyword_stop, carrier_opted_out, manual

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Response Payload

data
array of object
required

Page of suppressions, most recent opt-out first.

Show child attributes
data.id
string
required
data.destination
string
required

The subscriber, in E.164 format.

data.originator
string
required

The sender this stops. A suppression covers one sender, so your other senders still reach this subscriber. Opting out of one of your programs does not opt out of the others.

data.reason
string
required
data.origin
string
required
data.applies_to
string
required
data.blocking
boolean
required

Whether this is stopping messages right now. Always true in a list, which carries only the suppressions in force; false when you fetch one by ID that has since ended, which is also when ended_at is set.

data.source_sms_id
nullable string

The inbound message the subscriber opted out with, or the outbound message whose delivery report reported the opt-out. Null when neither applies.

data.effective_at
string
required

When the subscriber opted out, as reported by whoever reported it. This is what orders one subscriber's history, and it can be earlier than created_at when a message reached us late.

data.ended_at
nullable string

When this stopped applying. Null while it is still stopping messages.

data.ended_reason
nullable string

What ended it. Null while it is still stopping messages.

data.ended_effective_at
nullable string

When the subscriber opted back in, as reported. Null while it is still stopping messages.

data.source_end_sms_id
nullable string

The inbound message the subscriber opted back in with, when there was one. Null while it is still stopping messages, and when something other than a start keyword ended it.

data.created_at
string
required

When we recorded it.

data.last_asserted_at
string
required

When we last recorded the subscriber opting out of this sender. Later than created_at when they texted a stop keyword again while already suppressed, which adds no new record but does earn another confirmation reply.

next_cursor
nullable string
required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Related resources

Continue with the documentation, guides and examples for this topic.

Try the practice and get an implementation brief