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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| filter | string | No | Filters 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. |
| fields | string | No | Comma-separated properties to return, for example email_addresses,phone_numbers,tag_ids,owner_id,custom_fields,create_time. |
| order_by | string | No | Field and direction separated by a space: id, create_time, email or update_time, then asc or desc, for example create_time desc. |
| page_size | integer | No | Contacts per page, up to 1000. |
| page_token | string | No | The 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.
Otras tools de Keap
- Crear contactoPOSTCrea un contacto y lo devuelve. Requiere al menos un elemento en email_addresses, phone_numbers o addresses. Con duplicate_option, un contacto coincidente se actualiza en lugar de crear uno nuevo.
- Actualizar contactoPATCHActualiza los campos enviados y devuelve el contacto. Los campos omitidos mantienen sus valores, pero cada lista enviada (email_addresses, phone_numbers, addresses) reemplaza la lista completa.
- Listar tagsGETLista los tags de la app Keap en tags, con id, name, description y category, y next_page_token para la página siguiente.
- Crear tagPOSTCrea un tag y lo devuelve con su id. El tag no se aplica a nadie hasta Aplicar tag.
- Aplicar tagPOSTAplica un tag a uno o más contactos. Aplicar un tag puede disparar las automatizaciones de la app Keap que lo escuchan, como secuencias de email.
- Quitar tagPOSTQuita un tag de uno o más contactos. El tag en sí permanece en la app Keap.
- Listar oportunidadesGETLista las oportunidades del embudo de ventas en opportunities, cada una con su contacto, etapa y usuario, y next_page_token para la página siguiente.
- Crear oportunidadPOSTCrea una oportunidad para un contacto en una etapa del embudo y la devuelve. opportunity_title, contact_id y stage_id son obligatorios.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
