Lister les opportunités avec l'API Salesflare

Liste les opportunités, avec étape, valeur, compte et responsable. close_after et close_before filtrent sur close_date. Paginez avec limit et offset ; une page plus courte que limit est la dernière.

Identifiant
salesflare_list_opportunities

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
searchstringNonText to search for in the opportunities.
idintegerNonId of one opportunity, from List opportunities or Create opportunity, to read only that one.
namestringNonName of the opportunity.
pipelineintegerNonId of a pipeline, from List pipelines.
stageintegerNonId of a stage, from the stages of List pipelines.
accountintegerNonId of an account, from List accounts.
ownerintegerNonId of the owner, from List users.
closedbooleanNonFilters by closed.
donebooleanNonFilters by done.
min_valuenumberNonLowest value.
max_valuenumberNonHighest value.
close_afterstringNonOnly the opportunities with close_date after this moment, in ISO 8601.
close_beforestringNonOnly the opportunities with close_date before this moment, in ISO 8601.
order_byarrayNonSort keys, each a field name for ascending or the name followed by desc, such as value desc.
limitintegerNonOpportunities per page.
offsetintegerNonOpportunities to skip, for the next page.

Connexions possibles

Votre client connecte son compte Salesflare une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/salesflare_list_opportunities. Il devient la définition de tool de votre agent sans conversion.

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.