Listar contratos de arriendo

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

Contratos de arrendamiento, del más reciente al más antiguo (pageSize máximo 100).

Permiso
leases:read
Claves
Solo secreta (desde un servidor)

Encabezados

X-API-Keystringobligatorio
Tu clave secreta.

Parámetros de consulta

statusstring
Estado del contrato DRAFTACTIVEEXPIREDTERMINATEDRENEWED
propertyIdstring
Propiedad arrendada
tenantIdstring
Contacto arrendatario
pageinteger
Página, desde 1 · default=1 · ≥ 1
pageSizeinteger
Contratos por página (máximo 100) · default=20 · 1–100

Respuestas

200Página de contratos
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/leases" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/leases", {
  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/leases",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Respuesta · 200 · ejemplo
{
  "data": [
    {
      "id": "clx1lea001",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2027-01-01T00:00:00.000Z",
      "monthlyRent": "2500000.00",
      "adminFee": "350000.00",
      "securityDeposit": "2500000.00",
      "status": "DRAFT",
      "paymentDayOfMonth": 5,
      "lateFeePercentage": "2.00",
      "createdAt": "2025-12-20T10:00:00.000Z",
      "property": {
        "id": "clx1prop002",
        "title": "Apto 301 Laureles",
        "address": "Cra 76 #35-18",
        "city": "Medellín",
        "type": "APARTMENT"
      },
      "tenant": {
        "id": "clx1con001",
        "firstName": "María",
        "lastName": "González",
        "phone": "+573009876543",
        "email": "[email protected]"
      },
      "manager": {
        "id": "clx1usr001",
        "firstName": "Carlos",
        "lastName": "Rodríguez"
      }
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "pageSize": 20,
    "totalPages": 8
  }
}

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