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ámetroTipoObligatorioDescripción
searchstringNoText to search for in the opportunities.
idintegerNoId of one opportunity, from List opportunities or Create opportunity, to read only that one.
namestringNoName of the opportunity.
pipelineintegerNoId of a pipeline, from List pipelines.
stageintegerNoId of a stage, from the stages of List pipelines.
accountintegerNoId of an account, from List accounts.
ownerintegerNoId of the owner, from List users.
closedbooleanNoFilters by closed.
donebooleanNoFilters by done.
min_valuenumberNoLowest value.
max_valuenumberNoHighest value.
close_afterstringNoOnly the opportunities with close_date after this moment, in ISO 8601.
close_beforestringNoOnly the opportunities with close_date before this moment, in ISO 8601.
order_byarrayNoSort keys, each a field name for ascending or the name followed by desc, such as value desc.
limitintegerNoOpportunities per page.
offsetintegerNoOpportunities 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.

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.