Saltar al contenido principal
GET
@firma-dev/sdk

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de consulta

page
integer
predeterminado:1

Número de página

Rango requerido: x >= 1
page_size
integer
predeterminado:50

Elementos por página

Rango requerido: 1 <= x <= 200
name
string

Filtrar por nombre de la solicitud de firma (coincidencia parcial, sin distinción entre mayúsculas y minúsculas)

status
enum<string>

Filtrar por estado de la solicitud de firma. Admite múltiples valores separados por comas.

Estados disponibles:

  • not_sent: Solicitud creada pero aún no enviada a los firmantes
  • in_progress: Enviada a los firmantes pero no completada, cancelada, rechazada ni expirada
  • finished: Todos los firmantes han completado
  • cancelled: La solicitud fue cancelada por el remitente
  • declined: Un firmante rechazó firmar (la solicitud se detiene)
  • deleted: Registros eliminados de forma parcial (normalmente ocultos)
  • expired: Enviada pero pasado el tiempo de expiración (sent_on + expiration_hours < now)

Ejemplo: ?status=in_progress,expired

Nota: El estado expired usa filtrado posterior, lo que puede tener implicaciones de rendimiento en conjuntos de datos grandes.

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

Filtrar solicitudes de firma creadas después de esta fecha (formato ISO 8601)

created_before
string<date-time>

Filtra las solicitudes de firma creadas antes de esta fecha (formato ISO 8601)

signer_email
string

Filtra por dirección de email del firmante (coincidencia exacta)

signer_name
string

Filtra por nombre del firmante (coincidencia parcial, sin distinguir mayúsculas/minúsculas)

sort_by
enum<string>
predeterminado:created_on

Campo por el que ordenar

Opciones disponibles:
name,
created_on,
expiration_hours,
sent_on,
finished_on
sort_order
enum<string>
predeterminado:desc

Orden de clasificación

Opciones disponibles:
asc,
desc

Respuesta

Solicitudes de firma obtenidas correctamente

Lista paginada de solicitudes de firma

results
object[]
requerido
pagination
object
requerido

Metadatos de paginación para respuestas de listas