Passer au contenu principal
GET
/
signing-requests
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

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

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

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', 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",
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"

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")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "document_url": "<string>",
      "document_url_expires_at": "2023-11-07T05:31:56Z",
      "page_count": 2,
      "expiration_hours": 168,
      "expires_at": "2023-11-07T05:31:56Z",
      "credit_cost": 1,
      "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settings": {
        "allow_download": true,
        "attach_pdf_on_finish": true,
        "allow_editing_before_sending": false,
        "use_signing_order": true,
        "hand_drawn_only": false,
        "send_signing_email": true,
        "send_finish_email": true,
        "send_expiration_email": true,
        "send_cancellation_email": true,
        "require_otp_verification": null,
        "disable_guided_navigation": true,
        "allow_presigning_download": true,
        "show_qr_code": true,
        "identity_editable_fields": [
          "<string>"
        ],
        "notify_identity_change_email": false
      },
      "updated_date": "2023-11-07T05:31:56Z",
      "sent_date": "2023-11-07T05:31:56Z",
      "finished_date": "2023-11-07T05:31:56Z",
      "cancelled_date": "2023-11-07T05:31:56Z",
      "declined_date": "2023-11-07T05:31:56Z",
      "recipients": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "jsmith@example.com",
          "order": 2,
          "finished_date": "2023-11-07T05:31:56Z",
          "signature_details": {}
        }
      ],
      "fields": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "required": true,
          "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variable_name": "<string>",
          "variable_defined_name": "<string>",
          "position": {
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123
          },
          "value": "<string>",
          "dropdown_options": [
            "<string>"
          ],
          "format_rules": {
            "dateFormat": "MMMM dd, yyyy"
          },
          "validation_rules": {}
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 123,
    "page_size": 123,
    "total_count": 123,
    "total_pages": 123
  }
}
{
"error": "Unauthorized",
"message": "Invalid API key"
}
{
"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 requête

page
integer
défaut:1

Numéro de page

Plage requise: x >= 1
page_size
integer
défaut:50

Éléments par page

Plage requise: 1 <= x <= 200
name
string

Filtrer par nom de demande de signature (correspondance partielle, insensible à la casse)

status
enum<string>

Filtrer par statut de demande de signature. Prend en charge plusieurs valeurs séparées par des virgules.

Statuts disponibles :

  • not_sent : Demande créée mais pas encore envoyée aux signataires
  • in_progress : Envoyée aux signataires mais pas terminée, annulée, refusée ou expirée
  • finished : Tous les signataires ont terminé
  • cancelled : La demande a été annulée par l'expéditeur
  • declined : Un signataire a refusé de signer (la demande est arrêtée)
  • deleted : Enregistrements supprimés en douceur (normalement masqués)
  • expired : Envoyée mais au-delà du délai d'expiration (sent_on + expiration_hours < maintenant)

Exemple : ?status=in_progress,expired

Remarque : Le statut expired utilise un post-filtrage qui peut avoir des implications sur les performances avec de grands ensembles de données.

Options disponibles:
not_sent,
in_progress,
finished,
cancelled,
declined,
deleted,
expired
created_after
string<date-time>

Filtrer les demandes de signature créées après cette date (format ISO 8601)

created_before
string<date-time>

Filtre les demandes de signature créées avant cette date (format ISO 8601)

signer_email
string

Filtre par adresse email du signataire (correspondance exacte)

signer_name
string

Filtre par nom du signataire (correspondance partielle, insensible à la casse)

sort_by
enum<string>
défaut:created_on

Champ utilisé pour le tri

Options disponibles:
name,
created_on,
expiration_hours,
sent_on,
finished_on
sort_order
enum<string>
défaut:desc

Ordre de tri

Options disponibles:
asc,
desc

Réponse

Demandes de signature récupérées avec succès

Liste paginée des demandes de signature

results
object[]
requis
pagination
object
requis

Métadonnées de pagination pour les réponses de type liste