Listar pipelines

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

Pipelines de la organización con sus etapas en orden y la cantidad de negocios en cada una.

Permiso

deals:read

Claves

Solo secreta (desde un servidor)

Encabezados

X-API-Keystringobligatorio

Tu clave secreta.

Respuestas

200Pipelines con sus etapas

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

JavaScript

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

Respuesta · 200 · ejemplo

{
  "data": [
    {
      "id": "clx1pip001",
      "name": "Ventas",
      "description": "Pipeline principal de ventas",
      "isDefault": true,
      "order": 0,
      "createdAt": "2025-06-01T10:00:00.000Z",
      "updatedAt": "2026-03-01T12:00:00.000Z",
      "_count": {
        "stages": 5
      },
      "stages": [
        {
          "id": "clx1stg001",
          "name": "Contacto inicial",
          "order": 0,
          "color": "#6366F1",
          "isDefault": true,
          "isWon": false,
          "isLost": false,
          "probability": 10,
          "maxDaysInStage": 7,
          "alertAfterDays": 5,
          "pipelineId": "clx1pip001",
          "_count": {
            "placements": 14
          }
        }
      ]
    }
  ]
}

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