Obtenir une séquence

GET /api/v1/sequences/{sequenceId} Le même objet, seul. publishedVersionId est la seule chose à lire ici : null signifie que rien ne s'exécute, quoi que dise le statut.

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 chemin

ParamètreTypeDescription
sequenceIdstringObligatoire. La séquence à lire

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/sequences/$SEQUENCE_ID"

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

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 | nullSujet éditorial que porte cette séquence, le cas échéant
data.createdAt / updatedAtstringDates ISO

Exemple de réponse

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "status": "subscribed",
    "publishedVersionId": "c41a7e55",
    "topicId": null,
    "createdAt` / `updatedAt": "value"
  }
}

Voir aussi