List opt-outs

Retrieve a list of opt-out blocks.

GET /messaging_optouts

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const messagingOptoutListResponse of client.messagingOptouts.list()) {
  console.log(messagingOptoutListResponse.messaging_profile_id);
}

200

{
  "data": [
    {
      "from": "<string>",
      "to": "+E.164",
      "messaging_profile_id": "<string>",
      "keyword": "STOP",
      "created_at": "2025-04-28 12:00:38.631252+00:00"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

redaction_enabled · string

If receiving address (+E.164 formatted phone number) should be redacted

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id], filter[from]

Show child attributes

page · object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

created_at · object

Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]

Show child attributes

Response

200

application/json

Successful response with opt-out list data

data · object[]

Show child attributes

meta · object

Show child attributes