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

# Document Auto Reminder Status

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

## Request

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

Retrieves the current auto reminder status per recipient for a specified document. Recipients who could not receive
reminders due to validations (recipient groups, non-signers, etc.) will be skipped and not included in the response.

## Path parameters

- `document_id` string, required

## Response `200`

Auto reminder status retrieved successfully.

- DocumentAutoRemindersResponse
  - `reminders` object[]
    - `recipient_id` string, required: Unique identifier of the recipient.
    - `status` 'sent' | 'error' | 'scheduled': Status of the reminder attempt (sent, error, scheduled).

## Other responses

- `400`: Returned when auto reminder status could not be retrieved due to the document's current status or reminders configuration. This occurs when: - The document has not been sent yet. - The document is in a final state (e.g., completed, paid, declined, or expired). - The auto reminders are disabled in the document settings.
- `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)