Buscar parties en Capsule CRM, con una API

Busca personas y organizaciones con los mismos resultados de la búsqueda global de Capsule, por nombre, código postal o teléfono, por ejemplo. Pagina con page, empezando en 1, y perPage, hasta 100.

Identificador
capsule_search_parties

La llamada

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

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

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
qstringSíText to search for, such as a name, a postcode or a phone number.
pageintegerNoPage to return, starting at 1.
perPageintegerNoParties per page, up to 100. The default is 50.
embedstringNoComma-separated extra data to include: tags, fields, organisation or missingImportantFields.

Conexiones posibles

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

Clave de API

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

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/capsule, 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/capsule_search_parties. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Capsule CRM

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