Listar series

GET /api/v1/series Lista las series de tu organización: secuencias guiadas por una fecha. Las secuencias de inscripción nunca aparecen aquí; léelas con listar secuencias.

Autorización

Rol	Acceso
`OWNER`	Permitido
`ADMIN`	Permitido
`MEMBER`	Permitido

Parámetros de consulta

Parámetro	Tipo	Descripción
`page`	number	Número de página, desde `1`
`limit`	number	Filas por página
`status`	string	`active` o `paused`
`search`	string	Coincide con el nombre de la serie

Ejemplo

bash

curl -s 'https://www.agentsmail.io/api/v1/series?status=active' \
  -H "x-api-key: $AGENTMAIL_API_KEY"

Respuesta

Código	Cuándo
`200`	La página, posiblemente vacía
`401`	Clave ausente o no válida

Campos de la respuesta

Campo	Tipo	Descripción
`success`	boolean	Siempre `true` aquí
`data`	array	Las series de esta página
`data[].id`	string	El id de la serie, también su id de secuencia
`data[].name`	string	Su nombre
`data[].status`	string	`active` o `paused`
`data[].startsAt`	string \| null	El día 1. `null` mientras no se fije: la serie no se puede publicar
`data[].listId`	string \| null	La lista a la que envía
`data[].audienceSegmentId`	string \| null	Acota esa lista
`data[].audienceTagId`	string \| null	La acota aún más
`data[].topicId`	string \| null	Su tema editorial
`pagination`	object	`total`, `page`, `limit`, `totalPages`

Ejemplo de respuesta

json

{
  "success": true,
  "data": [
    {
      "id": "7d7d7d7d-8888-4ccc-9ddd-eeee00001111",
      "name": "March launch",
      "status": "active",
      "startsAt": "2026-03-15T08:00:00.000Z",
      "listId": "9f8e7d6c-1111-4bbb-8ccc-ddddeeeeffff",
      "audienceSegmentId": null,
      "audienceTagId": null,
      "topicId": null,
      "createdAt": "2026-03-01T10:00:00.000Z",
      "updatedAt": "2026-03-02T10:00:00.000Z"
    }
  ],
  "pagination": {"total": 1, "page": 1, "limit": 20, "totalPages": 1}
}

Notas

El startsAt que lees aquí es el de la versión que decide: la publicada, o el borrador cuando todavía no hay nada publicado. Es el mismo valor que muestra la aplicación.