Quién la recorre

GET /api/v1/sequences/{sequenceId}/enrollments Cada inscripción responde a tres preguntas:
CampoLo que te dice
contactIdQuién la recorre. Lee el contacto en sí a través de la API de audiencia
currentNodeIdDónde está: un nodo de versionId, con nextStepDueAt como su próxima fecha prevista
versionIdA qué versión está fijado. Un contacto termina el recorrido en el que entró, publiques lo que publiques después
status es in_progress, completed o stopped, y la lista devuelve los tres. Un contacto que llegó al final no ha desaparecido: está completed, y sigue contando en el historial de la secuencia. Leer solo lo que está en curso mostraría una lista que se vacía sola.
Este endpoint lee. No hay forma de inscribir un contacto con él, ni ningún PATCH para mover a alguien a otro nodo: la inscripción ocurre a través del disparador, y el avance es cosa del motor.

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 consulta

ParámetroTipoDescripción
pagenumberPor defecto 1
limitnumberPor defecto 20, máximo 100

Ejemplo

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

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

CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data[].idstringIdentificador de la inscripción
data[].contactIdstringQuién la recorre: lee el contacto a través de la API de audiencia
data[].statusstringin_progress, completed o stopped
data[].currentNodeIdstringnull
data[].enrolledAtstringFecha ISO en que entró
data[].completedAtstringnull
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

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

Relacionado