Listar pasos

GET /api/v1/sequences/{sequenceId}/versions/{versionId}/nodes Los nodos de esa versión, cada uno con su type y las columnas que le corresponden. Las columnas que no corresponden al tipo valen null: no se omiten, así que nunca tienes que adivinar si un campo está vacío o ausente.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

ParámetroTipoDescripción
sequenceIdstringObligatorio. La secuencia
versionIdstringObligatorio. La versión cuyos pasos lees

Ejemplo

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

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 404 Not Found: no existe ese recurso, o pertenece a otra organización. La API nunca confirma que un id existe a quien no tiene derecho sobre él.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

data es un array de pasos, en el orden en que se recorren.
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data[].idstringIdentificador del paso
data[].versionIdstringLa versión, en borrador o publicada, a la que pertenece
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 / updatedAtstringFechas ISO
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

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
  }
}

Relacionado