Listar sobres de firma

GEThttps://api.bydomu.com/v1/envelopes

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Los 100 sobres de firma más recientes, con sus destinatarios. No se pagina.

Permission
documents:read
Keys
Secret only (server-side)

Headers

X-API-Keystringrequired
Your secret key.

Query parameters

statusstring
Estado del sobre (DRAFT, IN_PROGRESS, COMPLETED, EXPIRED, CANCELLED, DECLINED)
searchstring
Texto en el nombre del sobre o en el título de su negocio

Responses

200Sobres de firma
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/envelopes" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/envelopes", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/envelopes",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": [
    {
      "id": "clx1env001",
      "name": "Contrato de arrendamiento - Apto 301",
      "status": "DRAFT",
      "signingMode": "SEQUENTIAL",
      "expiresAt": "2026-10-30T23:59:59.000Z",
      "completedAt": "2026-09-22T15:10:00.000Z",
      "createdAt": "2026-09-15T09:00:00.000Z",
      "updatedAt": "2026-09-22T15:10:00.000Z",
      "deal": {
        "id": "clx1deal002",
        "title": "Arriendo Apto 301"
      },
      "createdBy": {
        "firstName": "Carlos",
        "lastName": "Rodríguez"
      },
      "recipients": [
        {
          "id": "clx1rcp001",
          "name": "María González",
          "email": "[email protected]",
          "role": "SIGNER",
          "order": 1,
          "status": "PENDING",
          "signedAt": "2026-09-22T15:10:00.000Z"
        }
      ]
    }
  ]
}

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.