Lister les contacts avec l'API Zendesk Sell

Liste les contacts que l'utilisateur peut voir, personnes et organisations, filtrés selon les arguments donnés, 25 par page par défaut. Chaque élément contient l'enregistrement dans data, et meta.count indique combien sont arrivés dans la page. Paginez avec page et per_page.

Identifiant
zendesk_sell_list_contacts

L'appel

POST https://connect.reportei.com/api/tools/zendesk_sell_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "ids": "<ids>"
  }
}

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
idsstringNonComma-separated ids of the contacts to return, for example 1,2,3, from List contacts or Create contact.
is_organizationbooleanNontrue returns only organizations, false only people.
contact_idintegerNonId of an organization contact, from List contacts, to return the people who work for it.
owner_idintegerNonId of the user who owns the contacts, from List users.
namestringNonName of an organization contact.
first_namestringNonFirst name of a person.
last_namestringNonLast name of a person.
emailstringNonEmail address of the contact.
customer_statusstringNonCustomer status.Valeurs : none, current, past
prospect_statusstringNonProspect status.Valeurs : none, current, lost
sort_bystringNonField to sort by: id, name, first_name, last_name, email, created_at or updated_at. Append :desc for descending order, for example last_name:desc.
pageintegerNonPage number, starting at 1.
per_pageintegerNonContacts per page, up to 100. The default is 25.

Connexions possibles

Votre client connecte son compte Zendesk Sell 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/zendesk_sell, 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/zendesk_sell_list_contacts. Il devient la définition de tool de votre agent sans conversion.

Autres tools Zendesk Sell

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.