ByDomuDevelopers
Crear clave

Tablero de un pipeline

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

Las etapas del pipeline, en orden, cada una con sus negocios (vista de tablero). Un pipeline que no existe responde una lista vacía.

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

Encabezados

X-API-Keystringobligatorio
Tu clave secreta.

Parámetros de ruta

idstringobligatorio
ID del pipeline

Respuestas

200Etapas con sus negocios
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/pipelines/clx1pip001" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/pipelines/clx1pip001", {
  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/pipelines/clx1pip001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Respuesta · 200 · ejemplo
{
  "data": [
    {
      "id": "clx1stg002",
      "name": "Visita",
      "order": 1,
      "color": "#6366F1",
      "isDefault": false,
      "isWon": false,
      "isLost": false,
      "deals": [
        {
          "id": "clx1deal001",
          "code": "N-0031",
          "title": "Venta Apto Chapinero - María González",
          "value": "350000000.00",
          "currency": "COP",
          "probability": 40,
          "status": "OPEN",
          "closedAt": "2026-10-30T18:00:00.000Z",
          "expectedCloseDate": "2026-11-30T00:00:00.000Z",
          "lostReason": "Compró con otra inmobiliaria",
          "lostReasonCategory": "COMPETENCIA",
          "intent": "PURCHASE",
          "budgetMin": "300000000.00",
          "budgetMax": "400000000.00",
          "preferredZones": [
            "Chapinero"
          ],
          "propertyTypes": [
            "APARTMENT"
          ],
          "leadSource": "REFERRAL",
          "notes": "Pre-aprobada para crédito hipotecario.",
          "agentId": "clx1usr001",
          "contactId": "clx1con001",
          "createdAt": "2026-09-01T08:00:00.000Z",
          "updatedAt": "2026-09-25T16:45:00.000Z",
          "contact": {
            "id": "clx1con001",
            "firstName": "María",
            "lastName": "González",
            "phone": "+573001234567"
          },
  …

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