# Recent SMS Opt-out

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`.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "PandaDoc Public API",
    "description": "PandaDoc API spans a broad range of functionality to help you build incredible documents automation experiences inside your product.\n\nPandaDoc API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.\n\n## Getting started\n\nYou can start testing PandaDoc API with a sandbox key on our [Enterprise](https://www.pandadoc.com/pricing/) plan, either active or in trial.\n\nGenerate your [sandbox key](https://developers.pandadoc.com/reference/sandbox-key) on the Developer Dashboard with predefined [rate limits](https://developers.pandadoc.com/reference/limits). Or contact our solutions expert if you work with high-transaction volumes.\n\n## Guides\n\nIf you’re just getting started with PandaDoc, you may want to jump straight into one of our [getting started guides](https://developers.pandadoc.com/docs/getting-started) for the feature you’re most interested in, whether that’s:\n\n- [Create from template](https://developers.pandadoc.com/docs/create-send-document),\n- [Upload and send a local PDF](https://developers.pandadoc.com/docs/upload-and-send-a-local-pdf),\n- or [Listening for changes in document status](https://developers.pandadoc.com/docs/listen-document-status-changes).\n\nWe also recommend you to discover our dynamic content generation on a fly: [Create from a template with content placeholder](https://developers.pandadoc.com/docs/create-with-content-placeholders-from-template).\n",
    "termsOfService": "https://www.pandadoc.com/master-services-agreement/",
    "contact": {
      "name": "PandaDoc API Support",
      "url": "https://developers.pandadoc.com/",
      "email": "api-track@pandadoc.com"
    },
    "license": {
      "name": "MIT",
      "url": "https://github.com/PandaDoc/pandadoc-openapi-specification/blob/main/LICENSE"
    },
    "version": "7.18.2"
  },
  "servers": [
    {
      "url": "https://api.pandadoc.com",
      "description": "Public API"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "Communication Preferences",
      "description": "Operations for managing communication preferences, including SMS opt-out settings."
    }
  ],
  "paths": {
    "/public/v1/sms-opt-outs": {
      "get": {
        "summary": "Recent SMS Opt-out",
        "operationId": "listRecentSmsOptOuts",
        "description": "Retrieves a list of the most recent SMS opt-out changes for each phone numbers used in your workspace.\n\n> 📘 You can filter results by time range using `timestamp_from` and `timestamp_to`.\n",
        "tags": [
          "Communication Preferences"
        ],
        "parameters": [
          {
            "name": "timestamp_from",
            "in": "query",
            "description": "The start of the timestamp. \n\nIf no timestamp is provided, 1 hour before the current time will be used.\n",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "example": "2025-01-28T00:00:00Z"
          },
          {
            "name": "timestamp_to",
            "in": "query",
            "description": "The end of the timestamp range. \n\nIf no timestamp is provided the current time will be used.\n",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "example": "2025-01-28T23:59:59Z"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of phone numbers, their SMS current opt-out statuses and timestamp of the last change.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListSmsOptOutChangelogResponse"
                },
                "examples": {
                  "List SMS Opt-out Changelog": {
                    "value": {
                      "results": [
                        {
                          "phone_number": "+1234567890",
                          "status": "opt-out",
                          "opt_out_changed": "2025-01-28T12:00:00Z"
                        },
                        {
                          "phone_number": "+1234567891",
                          "status": "opt-in",
                          "opt_out_changed": "2025-01-28T12:00:00Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400RequestError"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "The `Authorization` header must contain the API key. The value should be prefixed with `API-Key` followed by a space and the actual API key.\n",
        "x-default": "API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.pandadoc.com/oauth2/authorize",
            "tokenUrl": "https://api.pandadoc.com/oauth2/access_token",
            "refreshUrl": "https://api.pandadoc.com/oauth2/access_token",
            "scopes": {
              "read+write": "Use `read+write` to create, send, delete, and download documents, and `read` to view templates and document details."
            }
          }
        },
        "description": "Send the authenticating user to the PandaDoc OAuth2 request URL. We recommend a button or a link titled\n\"Connect to PandaDoc\" if you are connecting users from a custom application. Users will see the \"Authorize Application\" screen.\nWhen the user clicks \"Authorize\", PandaDoc redirects the user back to your site with an authorization code inside the URL.\n\nhttps://app.pandadoc.com/oauth2/authorize?client_id={client_id}&redirect_uri={redirect_uri}&scope=read+write&response_type=code\n\n`client_id` and `redirect_uri` values should match your application settings.\n"
      }
    },
    "schemas": {
      "ListSmsOptOutChangelogResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "phone_number": {
                  "type": "string",
                  "example": "+1234567890"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "opt-in",
                    "opt-out"
                  ],
                  "example": "opt-out"
                },
                "opt_out_changed": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2025-01-28T12:00:00Z"
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "401": {
        "description": "Authentication error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "authentication_error"
                },
                "detail": {
                  "type": "string",
                  "example": "Authentication credentials were not provided."
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "Permission error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "permission_error"
                },
                "detail": {
                  "type": "string",
                  "example": "You do not have permission to perform this action."
                },
                "info_message": {
                  "type": "string",
                  "description": "Human-readable explanation of the permission error.",
                  "example": "You are not allowed to send documents outside of your organization"
                },
                "links": {
                  "type": "array",
                  "description": "Optional links related to the error (e.g. a status endpoint).",
                  "items": {
                    "type": "object",
                    "properties": {
                      "rel": {
                        "type": "string",
                        "example": "status"
                      },
                      "href": {
                        "type": "string",
                        "example": "https://api.pandadoc.com/public/v1/documents/RsXrKarV524iCpjci9CMGa"
                      },
                      "type": {
                        "type": "string",
                        "example": "POST"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "429": {
        "description": "Too Many Requests",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "throttled"
                },
                "detail": {
                  "type": "string",
                  "example": "Request was throttled."
                }
              }
            }
          }
        }
      },
      "400RequestError": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "request_error"
                },
                "detail": {
                  "type": "object",
                  "example": {
                    "count": [
                      "A valid integer is required."
                    ],
                    "order_by": [
                      "value is not a valid choice."
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```