Listar oportunidades en Salesflare, con una API
Lista las oportunidades, con etapa, valor, cuenta y responsable. close_after y close_before filtran por close_date. Pagina con limit y offset; una página menor que limit es la última.
- Identificador
- salesflare_list_opportunities
La llamada
POST https://connect.reportei.com/api/tools/salesflare_list_opportunities/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"search": "<search>"
}
}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 |
|---|---|---|---|
| search | string | No | Text to search for in the opportunities. |
| id | integer | No | Id of one opportunity, from List opportunities or Create opportunity, to read only that one. |
| name | string | No | Name of the opportunity. |
| pipeline | integer | No | Id of a pipeline, from List pipelines. |
| stage | integer | No | Id of a stage, from the stages of List pipelines. |
| account | integer | No | Id of an account, from List accounts. |
| owner | integer | No | Id of the owner, from List users. |
| closed | boolean | No | Filters by closed. |
| done | boolean | No | Filters by done. |
| min_value | number | No | Lowest value. |
| max_value | number | No | Highest value. |
| close_after | string | No | Only the opportunities with close_date after this moment, in ISO 8601. |
| close_before | string | No | Only the opportunities with close_date before this moment, in ISO 8601. |
| order_by | array | No | Sort keys, each a field name for ascending or the name followed by desc, such as value desc. |
| limit | integer | No | Opportunities per page. |
| offset | integer | No | Opportunities to skip, for the next page. |
Conexiones posibles
Tu cliente conecta su cuenta de Salesflare 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.
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/salesflare_list_opportunities. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Salesflare
- Listar cuentasGETLista las cuentas, las empresas del equipo, 10 por página por defecto. Pagina con limit y offset; una página menor que limit es la última.
- Obtener cuentaGETDevuelve una cuenta con direcciones, emails, teléfonos, etiquetas y campos personalizados.
- Crear cuentaPOSTCrea una cuenta, la empresa a la que pertenecen contactos y oportunidades. Devuelve la nueva cuenta con su id.
- Actualizar cuentaPUTActualiza los campos indicados de una cuenta.
- Listar contactosGETLista los contactos del equipo, 20 por página por defecto. Pagina con limit y offset; una página menor que limit es la última.
- Obtener contactoGETDevuelve un contacto con su cuenta, cargos, teléfonos, direcciones, etiquetas y campos personalizados.
- Crear contactoPOSTCrea un contacto, vinculado a una cuenta con account. Devuelve el nuevo contacto con su id.
- Actualizar contactoPUTActualiza los campos indicados de un contacto. archived true lo archiva.
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.
