Passer au contenu principal
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
}
}

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

id
string<uuid>
requis

ID de la demande de signature

Réponse

Rappels de la demande de signature récupérés avec succès

id
string<uuid>
requis

Identifiant unique du rappel

hours
integer
requis

Nombre d'heures après l'envoi avant l'envoi du rappel

Plage requise: x >= 1
subject
string
requis

Objet de l'email pour le rappel

Maximum string length: 255
message
string
requis

Corps du message de l'email pour le rappel

Maximum string length: 5000
all_users
boolean

Indique si le rappel s'applique à tous les utilisateurs

template_user_id
string<uuid> | null

Utilisateur spécifique auquel envoyer le rappel (utilisé dans le contexte d'un modèle)

recipient_id
string<uuid> | null

Destinataire spécifique auquel envoyer le rappel (utilisé dans le contexte d'une demande de signature, identique à template_user_id)

sent_on
string<date-time> | null

Horodatage du moment où le rappel a réellement été envoyé

created_at
string<date-time>

Horodatage de création du rappel

updated_at
string<date-time>

Horodatage de dernière mise à jour du rappel