Listar contactos en Keap, con una API

Lista los contactos de la app Keap en contacts, con next_page_token para la página siguiente. Sin fields, cada contacto viene con un conjunto predeterminado de propiedades. Filtra por email, nombre, ids y otros campos con filter.

Identificador
keap_list_contacts

La llamada

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

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

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
filterstringNoFilters joined by ;, each one field==value, for example email==ana@acme.com or given_name==Mar* for a prefix. Fields: email, given_name, family_name, ids (comma-separated, from List contacts), city, state, website, start_update_time and end_update_time (ISO 8601 with milliseconds), plus custom fields by field name.
fieldsstringNoComma-separated properties to return, for example email_addresses,phone_numbers,tag_ids,owner_id,custom_fields,create_time.
order_bystringNoField and direction separated by a space: id, create_time, email or update_time, then asc or desc, for example create_time desc.
page_sizeintegerNoContacts per page, up to 1000.
page_tokenstringNoThe next_page_token of the previous response. Omit it on the first page.

Conexiones posibles

Tu cliente conecta su cuenta de Keap 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/keap, 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/keap_list_contacts. Se convierte en la definición de tool de tu agente sin conversión.

Mira Connect aplicado a tu producto.

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