---
title: "Recent SMS Opt-out"
method: GET
path: "/public/v1/sms-opt-outs"
tags: ["Communication Preferences"]
---

# Recent SMS Opt-out

`GET /public/v1/sms-opt-outs`

## Request

- Base URL: `https://api.pandadoc.com`
- URL: `https://api.pandadoc.com/public/v1/sms-opt-outs`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://app.pandadoc.com/oauth2/authorize`
    - Token URL: `https://api.pandadoc.com/oauth2/access_token`
- TypeScript: <https://skmtc.dev/pandadoc/apis/pandadoc-public-api/docs/public/v1/sms-opt-outs/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of the most recent SMS opt-out changes for each phone numbers used in your workspace.

> 📘 You can filter results by time range using `timestamp_from` and `timestamp_to`.

## Query parameters

- `timestamp_from` string, date-time
- `timestamp_to` string, date-time

## Response `200`

A list of phone numbers, their SMS current opt-out statuses and timestamp of the last change.

- ListSmsOptOutChangelogResponse
  - `results` object[]
    - `phone_number` string
    - `status` 'opt-in' | 'opt-out'
    - `opt_out_changed` string, date-time

## Other responses

- `400`: Bad Request
- `401`: Authentication error
- `403`: Permission error
- `429`: Too Many Requests

---

[API](https://skmtc.dev/pandadoc/apis/pandadoc-public-api.md) - [All operations](https://skmtc.dev/pandadoc/apis/pandadoc-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pandadoc/apis/pandadoc-public-api/revisions/b9a306b1a421?raw)
