Listar contactos en Freshdesk, con una API

Lista contactos, los clientes que abren tickets, con id, name, email, phone, mobile, company_id, tags y custom_fields. Los filtros se combinan.

Identificador
freshdesk_list_contacts

La llamada

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

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

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
emailstringNoOnly the contact with this email address.
mobilestringNoOnly contacts with this mobile number.
phonestringNoOnly contacts with this phone number.
company_idintegerNoOnly the contacts of this company, from Search companies.
statestringNoOnly contacts in this state.Valores: blocked, deleted, unverified, verified
updated_sincestringNoOnly contacts updated at or after this UTC time, for example 2026-10-01T00:00:00Z.
pageintegerNoPage number, starting at 1.
per_pageintegerNoContacts per page, up to 100. The default is 30.

Conexiones posibles

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

Usuario y contraseña

Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.

Al conectar, tu cliente también indica {domain}: la dirección de su cuenta en la API de la app.

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

Otras tools de Freshdesk

Ver las 13 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.