Qui la parcourt

GET /api/v1/sequences/{sequenceId}/enrollments Chaque inscription répond à trois questions :

Champ	Ce qu'il vous apprend
`contactId`	Qui parcourt. Lisez le contact lui-même via l'API Audience
`currentNodeId`	Où il en est — un nœud de `versionId`, avec `nextStepDueAt` comme prochaine échéance
`versionId`	À quelle version il est rattaché. Un contact termine le parcours dans lequel il est entré, quoi que vous publiiez ensuite

status vaut in_progress, completed ou stopped, et la liste renvoie les trois. Un contact arrivé au bout n'a pas disparu : il est completed, et il compte toujours dans l'historique de la séquence. Ne lire que ce qui est en cours donnerait une liste qui se vide d'elle-même.

Cet endpoint lit. Il ne permet pas d'inscrire un contact, et aucun PATCH ne déplace quelqu'un vers un autre nœud — l'inscription passe par le déclencheur, et la progression appartient au moteur.

Autorisation

Rôle dans l'organisation	Cet endpoint
`OWNER`	Autorisé
`ADMIN`	Autorisé
`MEMBER`	Autorisé

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ètre	Type	Description
`page`	number	`1` par défaut
`limit`	number	`20` par défaut, plafonné à `100`

Exemple

bash

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

Réponse

200 OK — l'appel a réussi.
401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
404 Not Found — aucune ressource de ce type, ou elle appartient à une autre organisation. L'API ne confirme jamais l'existence d'un id à un appelant qui n'y a pas droit.
429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

Champ	Type	Description
`success`	boolean	Indique si l'opération a réussi
`data[].id`	string	Identifiant de l'inscription
`data[].contactId`	string	Qui parcourt — lisez le contact via l'API Audience
`data[].status`	string	`in_progress`, `completed` ou `stopped`
`data[].currentNodeId`	string	null
`data[].enrolledAt`	string	Date ISO de son entrée
`data[].completedAt`	string	null
`pagination`	object	`{total, page, limit, totalPages}`

Exemple de réponse

json

{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "contactId": "4d19c0a2",
      "status": "subscribed",
      "currentNodeId": "d77b0913",
      "enrolledAt": "2026-08-23T10:22:05.000Z",
      "completedAt": "2026-08-23T10:22:05.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}