Templates

Get template reminders

Retrieve all reminders configured for a specific template

get/templates/{id}/reminders

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/templates/:id/reminders/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Template ID

Template reminders retrieved successfully

idstring uuid required

Unique identifier for the reminder

hoursinteger required

Hours after sending before reminder is sent

subjectstring required

Email subject for the reminder

messagestring required

Email message body for the reminder

all_usersboolean

Whether reminder applies to all users

template_user_idstring uuid nullable

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

recipient_idstring uuid nullable

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

sent_onstring date-time nullable

Timestamp when the reminder was actually sent

created_atstring date-time

Reminder creation timestamp

updated_atstring date-time

Reminder last update timestamp

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