Listar suscriptores en Kit, con una API
Lista los suscriptores con id, email, nombre, estado y campos personalizados, solo los activos por defecto. Busca uno por email_address. La respuesta trae subscribers y pagination; mientras has_next_page sea true, envía pagination.end_cursor como after.
- Identificador
- kit_list_subscribers
La llamada
POST https://connect.reportei.com/api/tools/kit_list_subscribers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email_address": "<email_address>"
}
}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 |
|---|---|---|---|
| email_address | string | No | Only the subscriber with exactly this email address. Does not work together with an engagement sort_field. |
| status | string | No | Only the subscribers in this state. The default is active, and all returns every state.Valores: active, inactive, bounced, complained, cancelled, all |
| created_after | string | No | Only the subscribers created after this date, as YYYY-MM-DD. |
| created_before | string | No | Only the subscribers created before this date, as YYYY-MM-DD. |
| updated_after | string | No | Only the subscribers updated after this date, as YYYY-MM-DD. |
| updated_before | string | No | Only the subscribers updated before this date, as YYYY-MM-DD. |
| sort_field | string | No | Field to sort by. The default is id. The engagement fields count the last 90 days, and cancelled_at needs status cancelled.Valores: id, created_at, updated_at, cancelled_at, engagement__sent, engagement__opens, engagement__clicks, engagement__open_rate, engagement__click_rate |
| sort_order | string | No | Order of the sort.Valores: asc, desc |
| include | string | No | Extra fields on each subscriber, separated by commas: attribution, tags, location, and canceled_at, which needs status cancelled. |
| per_page | integer | No | Subscribers per page, up to 1000. The default is 500. |
| after | string | No | The pagination.end_cursor of the previous page. |
Conexiones posibles
Tu cliente conecta su cuenta de Kit 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/kit, 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/kit_list_subscribers. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Kit
- Crear suscriptorPOSTCrea un suscriptor activo. Cuando el email ya pertenece a un suscriptor, actualiza el nombre de ese suscriptor en su lugar. No añade ninguna tag: usa Apply tag a continuación.
- Actualizar suscriptorPUTActualiza el email, el nombre o los campos personalizados de un suscriptor. Una clave de campo personalizado que no existe en la cuenta hace fallar la solicitud.
- Listar tagsGETLista las tags con id, nombre y fecha de creación. La respuesta trae tags y pagination; mientras has_next_page sea true, envía pagination.end_cursor como after.
- Crear tagPOSTCrea una tag y la devuelve con su id. Cuando ya existe una tag con el mismo nombre, sin distinguir mayúsculas, devuelve esa tag en lugar de una duplicada.
- Aplicar tagPOSTAplica una tag a un suscriptor existente, encontrado por email. Las automatizaciones de la cuenta que empiezan con esa tag se ejecutan para el suscriptor. Crea antes el suscriptor con Create subscriber.
- Listar formulariosGETLista los formularios y landing pages con id, nombre, tipo y URL de inserción, solo los activos por defecto. La respuesta trae forms y pagination; mientras has_next_page sea true, envía pagination.end_cursor como after.
- Listar segmentosGETLista los segmentos con id y nombre. Los segmentos se crean en la app de Kit, y sus ids definen el público de un broadcast en subscriber_filter. La respuesta trae segments y pagination; mientras has_next_page sea true, envía pagination.end_cursor como after.
- Listar broadcastsGETLista los broadcasts con id, asunto, contenido, estado, send_at, segmentación y plantilla de email. La respuesta trae broadcasts y pagination; mientras has_next_page sea true, envía pagination.end_cursor como after.
Toolkits de la misma categoría
AWeber12 tools
beehiiv12 tools
Brevo12 tools
Constant Contact12 tools
GetResponse13 tools
Mailjet15 tools
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
