Lister les étapes

GET /api/v1/sequences/{sequenceId}/versions/{versionId}/nodes Les nœuds de cette version, chacun avec son type et les colonnes qui lui appartiennent. Les colonnes qui n'appartiennent pas au type valent null — elles ne sont pas omises, pour que vous n'ayez jamais à deviner si un champ est vide ou absent.

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
versionIdstringObligatoire. La version dont vous lisez les étapes

Exemple

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

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

data est un tableau d'étapes, dans l'ordre où elles sont parcourues.
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data[].idstringIdentifiant de l'étape
data[].versionIdstringLa version brouillon ou publiée à laquelle elle appartient
data[].typestringsend_email, wait, add_tag, remove_tag, end_sequence, webhook
data[].subject / contentstring \null
data[].templateIdstring \null
data[].waitHoursnumber \null
data[].tagIdstring \null
data[].webhookUrlstring \null
data[].createdAt / updatedAtstringDates ISO
paginationobject{total, page, limit, totalPages}

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "versionId": "c41a7e55",
      "type": "send_email",
      "subject` / `content": "value",
      "templateId": "5a44b901",
      "waitHours": 24,
      "tagId": "7c2ef4b1",
      "webhookUrl": "https://example.com/hooks/agentsmail",
      "createdAt` / `updatedAt": "value"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Voir aussi