Passer au contenu principal
GET
@firma-dev/sdk

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