ByDomuDevelopers
Create key

Listar documentos

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

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

Documentos adjuntos a negocios, del más reciente al más antiguo (pageSize máximo 100).

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

Headers

X-API-Keystringrequired
Your secret key.

Query parameters

dealIdstring
Solo los de este negocio
pageinteger
Página, desde 1 · default=1 · ≥ 1
pageSizeinteger
Documentos por página (máximo 100) · default=20 · 1–100

Responses

200Página de documentos
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/documents" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/documents", {
  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/documents",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": [
    {
      "id": "clx1doc001",
      "name": "Promesa de compraventa.pdf",
      "url": "https://cdn.bydomu.com/docs/promesa.pdf",
      "mimeType": "application/pdf",
      "size": 245760,
      "dealId": "clx1deal001",
      "createdAt": "2026-09-18T11:30:00.000Z",
      "uploadedBy": {
        "id": "clx1usr001",
        "firstName": "Carlos",
        "lastName": "Rodríguez"
      }
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "pageSize": 20,
    "totalPages": 8
  }
}

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