---
title: "Document Auto Reminder Settings"
method: GET
path: "/public/v1/documents/{document_id}/auto-reminders"
tags: ["Document Reminders"]
---

# Document Auto Reminder Settings

`GET /public/v1/documents/{document_id}/auto-reminders`

## Request

- Base URL: `https://api.pandadoc.com`
- URL: `https://api.pandadoc.com/public/v1/documents/{document_id}/auto-reminders`
- 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/documents/:document_id/auto-reminders/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the current auto reminder configuration for a specified document.

## Path parameters

- `document_id` string, required

## Response `200`

Auto reminder settings retrieved successfully.

- AutoReminders
  - `enabled` boolean, required: Toggles auto-reminders for the document. If `true`, reminders are scheduled based on the configuration.
  - `delivery_method` 'email' | 'sms': The method used to deliver reminders (e.g., email, SMS).
  - `initial_delay_days` integer: Number of days to wait after sending the document before the first reminder is sent.
  - `is_recurring` boolean: If `true`, reminders will be sent repeatedly at specified intervals after the initial reminder.
  - `recurrence_frequency_days` integer: Number of days between recurring reminders, applicable if `is_recurring` is `true`.

## Other responses

- `400`: Returned when auto reminder settings could not be retrieved from the document. This occurs when document is in a final state (e.g., completed, paid, declined, or expired).
- `401`: Authentication error
- `403`: Permission error
- `404`: Not found
- `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)