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'organisation | Cet endpoint |
|---|---|
OWNER | Autorisé |
ADMIN | Autorisé |
MEMBER | Autorisé |
Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
sequenceId | string | Obligatoire. 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
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si l'opération a réussi |
data.id | string | Identifiant de la séquence |
data.name | string | Son nom |
data.status | string | active ou paused |
data.publishedVersionId | string \ | null |
data.topicId | string | null | Sujet éditorial que porte cette séquence, le cas échéant |
data.createdAt / updatedAt | string | Dates ISO |
Exemple de réponse
json
{
"success": true,
"data": {
"id": "4d19c0a2",
"name": "Newsletter",
"status": "subscribed",
"publishedVersionId": "c41a7e55",
"topicId": null,
"createdAt` / `updatedAt": "value"
}
}