Listar contactos en Zendesk Sell, con una API

Lista los contactos que el usuario puede ver, personas y organizaciones, filtrados por los argumentos indicados, 25 por página por defecto. Cada elemento trae el registro en data, y meta.count indica cuántos vinieron en la página. Pagina con page y per_page.

Identificador
zendesk_sell_list_contacts

La llamada

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

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
idsstringNoComma-separated ids of the contacts to return, for example 1,2,3, from List contacts or Create contact.
is_organizationbooleanNotrue returns only organizations, false only people.
contact_idintegerNoId of an organization contact, from List contacts, to return the people who work for it.
owner_idintegerNoId of the user who owns the contacts, from List users.
namestringNoName of an organization contact.
first_namestringNoFirst name of a person.
last_namestringNoLast name of a person.
emailstringNoEmail address of the contact.
customer_statusstringNoCustomer status.Valores: none, current, past
prospect_statusstringNoProspect status.Valores: none, current, lost
sort_bystringNoField 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.
pageintegerNoPage number, starting at 1.
per_pageintegerNoContacts per page, up to 100. The default is 25.

Conexiones posibles

Tu cliente conecta su cuenta de Zendesk Sell una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/zendesk_sell, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

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/zendesk_sell_list_contacts. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Zendesk Sell

Ver las 14 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

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