Listar documentos

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

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

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

Permissão

documents:read

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Parâmetros de consulta

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

Respostas

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.

{ "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 } }