Document Auto Reminder Settings

Retrieves the current auto reminder configuration for a specified document.

get/public/v1/documents/{document_id}/auto-reminders

Request

Base URL
https://api.pandadoc.com
Auth
- API key in header Authorization
- or OAuth 2
  Authorization codehttps://app.pandadoc.com/oauth2/authorize
  Token URLhttps://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.

document_idstring required

The UUID of the document.

Auto reminder settings retrieved successfully.

enabledboolean 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_daysinteger

Number of days to wait after sending the document before the first reminder is sent.

is_recurringboolean

If true, reminders will be sent repeatedly at specified intervals after the initial reminder.

recurrence_frequency_daysinteger

Number of days between recurring reminders, applicable if is_recurring is true.

No recorded changes to this operation across all 2 revisions of this API.