Listar personas en Crisp, con una API

Lista o busca los contactos (perfiles de personas) de un workspace, con people_id, email, name, company, segments y notepad. Las páginas empiezan en 1, y una página con menos elementos que per_page es la última.

Identificador
crisp_list_people

La llamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "website_id": "<website_id>",
    "page_number": 1
  }
}

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
website_idstringSíId of the workspace, from List websites.
page_numberintegerSíPage number, starting at 1.
per_pageintegerNoContacts per page, from 20 to 50. Defaults to 20.
search_textstringNoQuick search text, like a name or an email.
sort_fieldstringNoField to sort on, like nickname.
sort_orderstringNoSort order.Valores: ascending, descending
filter_date_startstringNoOnly contacts created from this moment on, in ISO 8601.
filter_date_endstringNoOnly contacts created up to this moment, in ISO 8601.

Conexiones posibles

Tu cliente conecta su cuenta de Crisp 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.

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

Otras tools de Crisp

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.