Skip to main content

List opt-outs

GET 
/messaging_optouts

Retrieve a list of opt-out blocks.

Request ​

Query Parameters

    filter[messaging_profile_id] string

    The ID of the messaging profile to retrieve opt-outs for

    created_at[gte] date-time

    Filter opt-outs created after this date (ISO-8601 format)

    filter[from] string

    The sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code) to retrieve opt-outs for

    created_at[lte] date-time

    Filter opt-outs created before this date (ISO-8601 format)

    redaction_enabled boolean

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

    Example: +447766****
    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses ​

200: Successful response with opt-out list data

Schema

    data

    object[]

  • Array [

    • from address

    Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).

    to address

    Receiving address (+E.164 formatted phone number or short code).

    messaging_profile_id stringnullable

    Unique identifier for a messaging profile.

    keyword stringnullable

    The keyword that triggered the opt-out.

    created_at date-time

    The timestamp when the opt-out was created

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request

Schema

    code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

401: Unauthorized

Schema

    code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

Request samples

curl -L 'https://api.telnyx.com/v2/messaging_optouts' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

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