Lister les opportunités avec l'API Keap
Liste les opportunités du pipeline de vente dans opportunities, chacune avec son contact, son étape et son utilisateur, et next_page_token pour la page suivante.
- Identifiant
- keap_list_opportunities
L'appel
POST https://connect.reportei.com/api/tools/keap_list_opportunities/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"filter": "<filter>"
}
}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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| filter | string | Non | Filters joined by ;, each one field==value, for example stage_id==3;user_id==5. Fields: stage_id (from List opportunity stages), user_id (from List users), contact_id (from List contacts), opportunity_title (with * for a prefix), ids (comma-separated, from List opportunities, up to 100), projected_revenue_low and projected_revenue_high (also with greater-than or less-than comparisons). |
| order_by | string | Non | Field and direction separated by a space: next_action_time, contact_name, opportunity_title, created_time or update_time, then asc or desc, for example created_time desc. |
| page_size | integer | Non | Opportunities per page, up to 1000. |
| page_token | string | Non | The next_page_token of the previous response. Omit it on the first page. |
Connexions possibles
Votre client connecte son compte Keap une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/keap, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
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/keap_list_opportunities. Il devient la définition de tool de votre agent sans conversion.
Autres tools Keap
- Lister les contactsGETListe les contacts de l'app Keap dans contacts, avec next_page_token pour la page suivante. Sans fields, chaque contact vient avec un ensemble de propriétés par défaut. Filtrez par email, nom, ids et autres champs avec filter.
- Créer un contactPOSTCrée un contact et le renvoie. Il faut au moins un élément dans email_addresses, phone_numbers ou addresses. Avec duplicate_option, un contact correspondant est mis à jour au lieu d'en créer un nouveau.
- Modifier un contactPATCHMet à jour les champs envoyés et renvoie le contact. Les champs omis gardent leurs valeurs, mais chaque liste envoyée (email_addresses, phone_numbers, addresses) remplace toute la liste.
- Lister les tagsGETListe les tags de l'app Keap dans tags, avec id, name, description et category, et next_page_token pour la page suivante.
- Créer un tagPOSTCrée un tag et le renvoie avec son id. Le tag n'est appliqué à personne avant Appliquer un tag.
- Appliquer un tagPOSTApplique un tag à un ou plusieurs contacts. Appliquer un tag peut déclencher les automatisations de l'app Keap qui l'écoutent, comme les séquences d'emails.
- Retirer un tagPOSTRetire un tag d'un ou plusieurs contacts. Le tag lui-même reste dans l'app Keap.
- Créer une opportunitéPOSTCrée une opportunité pour un contact à une étape du pipeline et la renvoie. opportunity_title, contact_id et stage_id sont obligatoires.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
