Lister les séries

GET /api/v1/series Liste les séries de votre organisation — les séquences pilotées par une date. Les séquences d'inscription n'apparaissent jamais ici ; lisez-les avec lister les séquences.

Autorisation

RôleAccès
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé

Paramètres de requête

ParamètreTypeDescription
pagenumberNuméro de page, à partir de 1
limitnumberLignes par page
statusstringactive ou paused
searchstringRecherche dans le nom de la série

Exemple

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

Réponse

CodeQuand
200La page, éventuellement vide
401Clé absente ou invalide

Champs de la réponse

ChampTypeDescription
successbooleanToujours true ici
dataarrayLes séries de cette page
data[].idstringL'identifiant de la série — c'est aussi celui de sa séquence
data[].namestringSon nom
data[].statusstringactive ou paused
data[].startsAtstring | nullLe jour 1. null tant qu'il n'est pas défini : la série ne peut pas être publiée
data[].listIdstring | nullLa liste à laquelle elle envoie
data[].audienceSegmentIdstring | nullRestreint cette liste
data[].audienceTagIdstring | nullLa restreint davantage
data[].topicIdstring | nullSon sujet éditorial
paginationobjecttotal, page, limit, totalPages

Exemple de réponse

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

Remarques

Le startsAt que vous lisez ici est celui de la version qui fait foi — la version publiée, ou le brouillon tant que rien n'est publié. C'est la même valeur que celle affichée dans l'application.

Voir aussi