GET /api/v1/sequences/{sequenceId}/enrollments
Cada inscripción responde a tres preguntas:
| Campo | Lo que te dice |
|---|---|
contactId | Quién la recorre. Lee el contacto en sí a través de la API de audiencia |
currentNodeId | Dónde está: un nodo de versionId, con nextStepDueAt como su próxima fecha prevista |
versionId | A 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ón | Este endpoint |
|---|---|
OWNER | Permitido |
ADMIN | Permitido |
MEMBER | Permitido |
Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
page | number | Por defecto 1 |
limit | number | Por 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
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Indica si la operación tuvo éxito |
data[].id | string | Identificador de la inscripción |
data[].contactId | string | Quién la recorre: lee el contacto a través de la API de audiencia |
data[].status | string | in_progress, completed o stopped |
data[].currentNodeId | string | null |
data[].enrolledAt | string | Fecha ISO en que entró |
data[].completedAt | string | null |
pagination | object | {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
}
}