Lister les séquences

GET /api/v1/sequences Chaque séquence porte id, name, status, publishedVersionId et ses dates.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Paramètres de requête

ParamètreTypeDescription
pagenumberNuméro de page, 1 par défaut
limitnumberÉléments par page, plafonné à 100

Paramètres de requête

ParamètreTypeDescription
statusstringactive ou paused
searchstringRecherche dans le nom
pagenumber1 par défaut
limitnumber20 par défaut, plafonné à 100

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/sequences?page=1&limit=20"

Réponse

  • 200 OK — l'appel a réussi.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

data est un tableau de séquences, accompagné d'un objet pagination.
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data[].idstringIdentifiant de la séquence
data[].namestringSon nom
data[].statusstringactive ou paused
data[].publishedVersionIdstring \null
data[].topicIdstring | nullLe sujet éditorial qu'elle porte, le cas échéant
data[].createdAt / updatedAtstringDates ISO
paginationobject{total, page, limit, totalPages}

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "name": "Newsletter",
      "status": "subscribed",
      "publishedVersionId": "c41a7e55",
      "createdAt` / `updatedAt": "value"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Voir aussi