Listar pipelines en Capsule CRM, con una API
Lista los pipelines de ventas de la cuenta. Usa el id de un pipeline en Listar milestones del pipeline.
- Identificador
- capsule_list_pipelines
La llamada
POST https://connect.reportei.com/api/tools/capsule_list_pipelines/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"includeDeleted": true
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| includeDeleted | boolean | No | Also returns archived pipelines. |
| page | integer | No | Page to return, starting at 1. |
| perPage | integer | No | Pipelines per page, up to 100. The default is 50. |
Conexiones posibles
Tu cliente conecta su cuenta de Capsule CRM una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/capsule, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/capsule_list_pipelines. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Capsule CRM
- Listar partiesGETLista las personas y organizaciones de la cuenta, 50 por página por defecto. Pagina con page, empezando en 1, y perPage, hasta 100; una página más corta que perPage es la última.
- Buscar partiesGETBusca personas y organizaciones con los mismos resultados de la búsqueda global de Capsule, por nombre, código postal o teléfono, por ejemplo. Pagina con page, empezando en 1, y perPage, hasta 100.
- Obtener partyGETDevuelve una persona u organización, con sus correos, teléfonos, direcciones y sitios web y el id de cada uno.
- Crear partyPOSTCrea una persona o una organización. Envía firstName y lastName para una persona y name para una organización. organisation vincula una persona por id, o por nombre, lo que crea la organización si aún no existe. Sin owner, la party va al usuario conectado.
- Actualizar partyPUTActualiza una persona u organización; los campos omitidos no cambian. En los arrays, un elemento sin id se añade, un elemento con id se modifica y un elemento con id y _delete true se elimina. Los ids vienen de Obtener party.
- Listar oportunidadesGETLista las oportunidades de la cuenta, con party, milestone, value y expectedCloseOn, 50 por página por defecto. Pagina con page, empezando en 1, y perPage, hasta 100; una página más corta que perPage es la última.
- Crear oportunidadPOSTCrea una oportunidad para una party, en un milestone de un pipeline. name, party y milestone son obligatorios.
- Actualizar oportunidadPUTActualiza una oportunidad; los campos omitidos no cambian. Moverla a otro milestone, como Won o Lost, es un cambio de milestone.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
