Lister les contacts avec l'API Keap

Liste 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.

Identifiant
keap_list_contacts

L'appel

POST https://connect.reportei.com/api/tools/keap_list_contacts/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ètreTypeObligatoireDescription
filterstringNonFilters joined by ;, each one field==value, for example email==ana@acme.com or given_name==Mar* for a prefix. Fields: email, given_name, family_name, ids (comma-separated, from List contacts), city, state, website, start_update_time and end_update_time (ISO 8601 with milliseconds), plus custom fields by field name.
fieldsstringNonComma-separated properties to return, for example email_addresses,phone_numbers,tag_ids,owner_id,custom_fields,create_time.
order_bystringNonField and direction separated by a space: id, create_time, email or update_time, then asc or desc, for example create_time desc.
page_sizeintegerNonContacts per page, up to 1000.
page_tokenstringNonThe 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_contacts. Il devient la définition de tool de votre agent sans conversion.

Autres tools Keap

Voir les 14 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

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