List series

GET /api/v1/series Lists the series of your organization — sequences driven by a date. Enrollment sequences never appear here; read those with list sequences.

Authorization

Role	Access
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Allowed

Query parameters

Parameter	Type	Description
`page`	number	Page number, from `1`
`limit`	number	Rows per page
`status`	string	`active` or `paused`
`search`	string	Matches the series name

Example

bash

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

Response

Code	When
`200`	The page, possibly empty
`401`	Missing or invalid key

Response fields

Field	Type	Description
`success`	boolean	Always `true` here
`data`	array	The series of this page
`data[].id`	string	The series id — also its sequence id
`data[].name`	string	Its name
`data[].status`	string	`active` or `paused`
`data[].startsAt`	string \| null	Day 1. `null` until it is set: the series cannot be published
`data[].listId`	string \| null	The list it sends to
`data[].audienceSegmentId`	string \| null	Narrows that list
`data[].audienceTagId`	string \| null	Narrows it further
`data[].topicId`	string \| null	Its editorial topic
`pagination`	object	`total`, `page`, `limit`, `totalPages`

Example response

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}
}

Notes

The startsAt you read here is the one on the version that decides — the published one, or the draft when nothing is published yet. It is the same value the app shows.