Skip to main content
GET
/
signing-requests
/
{id}
/
reminders
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.signingRequests.listSigningRequestReminders({
    id: "id"
});
console.log(response);
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/reminders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "remind789-e89b-12d3-a456-426614174000",
    "hours": 48,
    "subject": "Urgent: Document signature required",
    "message": "Please complete your signature at your earliest convenience.",
    "all_users": false,
    "template_user_id": "user456-e89b-12d3-a456-426614174000",
    "date_created": "2024-03-10T09:00:00Z",
    "date_changed": "2024-03-10T09:00:00Z"
  }
]
{
  "error": "Unauthorized",
  "message": "Invalid API key"
}
{
  "error": "Not Found",
  "message": "The requested resource was not found"
}
{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

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

Signing request ID

Response

Signing request reminders retrieved successfully

id
string<uuid>
required

Unique identifier for the reminder

hours
integer
required

Hours after sending before reminder is sent

Required range: x >= 1
subject
string
required

Email subject for the reminder

Maximum string length: 255
message
string
required

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