Detalle de documento

GEThttps://api.bydomu.com/v1/documents/{id}

Un documento con su URL de descarga.

Permiso

documents:read

Claves

Solo secreta (desde un servidor)

Encabezados

X-API-Keystringobligatorio

Tu clave secreta.

Parámetros de ruta

idstringobligatorio

ID del documento

Respuestas

200El documento

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.

404NOT_FOUND · El recurso no existe en la organización.

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/clx1doc001" \
  -H "X-API-Key: $BYDOMU_API_KEY"

JavaScript

const res = await fetch("https://api.bydomu.com/v1/documents/clx1doc001", {
  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/clx1doc001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()

Respuesta · 200 · ejemplo

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

La clave va en la variable BYDOMU_API_KEY. Los datos del ejemplo no son de ninguna inmobiliaria.