Obtener pipelines

Recupera los pipelines de ventas de la cuenta.

GET https://api.getincloud.ai/v1/pipelines

Recupera los pipelines de ventas de la cuenta.

Por defecto solo se devuelven los pipelines activos. Usa archived=true para los archivados, o archived=all para ambos: cada pipeline incluye un indicador archived y, cuando está archivado, la fecha archivedAt en que se archivó.

Cada pipeline incluye además sus propios contadores deals, cada uno un par {count, amount}: open en este momento, won / lost durante toda la vida del pipeline, y won30d / lost30d durante los últimos 30 días. El par acumulado es el que se usa para leer un pipeline archivado, ya que un embudo retirado hace más de un mes tiene una ventana de 30 días vacía. Los agentes restringidos solo cuentan sus propios deals.

deals.mixedCurrency incluye un indicador por cada cifra. Es true cuando los deals que componen ese importe no están todos en la misma moneda: deal.currency se inicializa con la moneda del pipeline, pero se almacena y puede sobrescribirse por cada deal, y no se aplica ningún tipo de cambio en ningún punto, por lo que un importe marcado es una suma de unidades distintas y no debe mostrarse como una única cifra. Un deal que no indica moneda propia no cuenta como una segunda moneda.

deals.currencies es su reflejo con la unidad en la que ESTÁ cada cifra, y es null exactamente cuando el indicador correspondiente es true. No es la misma respuesta que la currency del propio pipeline: un pipeline con precio en EUR cuyos deals cerrados se almacenaron todos en USD no mezcla nada, y expresar sus totales en la moneda del pipeline mostraría dólares con el símbolo del euro.

deals.scope indica de quién son los deals contados: account para todo el embudo, agent cuando quien consulta es un agente restringido y todas las cifras se han acotado a él. Es la misma declaración que hace el endpoint de resumen, y una pantalla que muestre estas cifras como hechos sobre el embudo la necesita para saber cuándo son hechos sobre quien consulta.

El número de pipelines activos que puede tener una cuenta es el máximo permitido por su plan (nunca más de 10), mientras que los archivados son ilimitados, por lo que la lista de archivados está paginada: una página que llega completa puede tener otra detrás (page=1, page=2, ...). Las lecturas que incluyen los archivados devuelven primero los activos, de modo que un límite de páginas solo puede recortar la cola de archivados.

Nota: este recurso de la API está disponible en la suscripción Platform Professional y superiores.

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Parámetros

Respuestas

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Get the account sales pipelines
curl --request GET \
  --url https://api.getincloud.ai/v1/pipelines \
  --header 'Token: <api token goes here>'