Listar publicaciones en beehiiv, con una API
Lista las publicaciones a las que llega la API key, con id, name y organization_name. expand stats añade suscripciones activas, tasas medias de apertura y clic y totales enviados. Pagina con page y limit, hasta 100; la respuesta trae total_pages.
- Identificador
- beehiiv_list_publications
La llamada
POST https://connect.reportei.com/api/tools/beehiiv_list_publications/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"expand": "stats"
}
}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 |
|---|---|---|---|
| expand | string | No | stats adds the statistics of each publication.Valores: stats |
| order_by | string | No | Sort field. The default is created.Valores: created, name |
| direction | string | No | Sort direction. The default is asc.Valores: asc, desc |
| limit | integer | No | Publications per page, up to 100. The default is 10. |
| page | integer | No | Page number, starting at 1. |
Conexiones posibles
Tu cliente conecta su cuenta de beehiiv 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.
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/beehiiv_list_publications. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de beehiiv
- Listar suscripcionesGETLista las suscripciones (suscriptores) de una publicación, opcionalmente solo de un email, estado o tier. Pagina con limit, hasta 100, y cursor: la respuesta trae has_more y next_cursor.
- Obtener suscripciónGETDevuelve una suscripción con email, status, created, subscription_tier, los campos utm y referral_code.
- Crear suscripciónPOSTSuscribe un email a una publicación y devuelve la suscripción con su id. Con double opt-in en la publicación, o double_opt_override activado, la persona confirma por email antes de quedar activa.
- Actualizar suscripciónPATCHActualiza una suscripción. Solo cambian los campos enviados. unsubscribe true da de baja a la persona de la publicación.
- Crear etiqueta de suscripciónPOSTAñade etiquetas a una suscripción. Una etiqueta que aún no existe en la publicación se crea.
- Listar postsGETLista los posts de una publicación con id, title, subtitle, status, publish_date y web_url. expand stats añade las estadísticas de email y web de cada post. Pagina con page y limit, hasta 100; la respuesta trae total_pages.
- Obtener postGETDevuelve un post; expand stats añade sus estadísticas de email y web. Un post creado hace un momento puede responder 202 mientras beehiiv lo construye, y 404 con POST_CREATION_FAILED cuando la creación falló.
- Crear postPOSTCrea un post a partir de HTML y devuelve su id; solo en los planes Pro y Enterprise. status draft, el valor por defecto, solo lo guarda; confirmed lo envía y publica de inmediato o en scheduled_at. beehiiv construye el post en segundo plano, así que Get post puede responder 202 por un momento.
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.
