Skip to main content
GET
/
templates
/
{id}
/
reminders
Get template reminders
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/reminders \
  --header 'Authorization: <api-key>'
[
  {
    "id": "remind123-e89b-12d3-a456-426614174000",
    "hours": 24,
    "subject": "Reminder: Please sign the document",
    "message": "This is a friendly reminder to complete your signature.",
    "all_users": true,
    "template_user_id": null,
    "created_date": "2024-01-15T10:30:00Z",
    "updated_date": "2024-01-15T10:30:00Z"
  }
]

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Template ID

Response

Template reminders retrieved successfully

​
id
string<uuid>

Unique identifier for the reminder

​
hours
integer

Hours after sending before reminder is sent

Required range: x >= 1
​
subject
string

Email subject for the reminder

Maximum string length: 255
​
message
string

Email message body for the reminder

Maximum string length: 5000
​
all_users
boolean

Whether reminder applies to all users

​
template_user_id
string<uuid> | null

Specific user to send reminder to (used in template context)

​
recipient_id
string<uuid> | null

Specific recipient to send reminder to (used in signing request context, same as template_user_id)

​
sent_on
string<date-time> | null

Timestamp when the reminder was actually sent

​
created_at
string<date-time>

Reminder creation timestamp

​
updated_at
string<date-time>

Reminder last update timestamp