Saltar para a documentação
API

Pessoas numa automação

As pessoas que entraram numa automação, da mais recente para a mais antiga, com o passo em que cada uma está. Uma inscrição lida por id traz também todos os passos que executou.

GET/automations/{id}/enrollments

Executa qualquer uma das 2 chamadas no seu espaço de trabalho.

GET /automations/{id}/enrollments

As pessoas que entraram numa automação, da mais recente para a mais antiga, com o passo em que cada uma está. Uma inscrição lida por id traz também todos os passos que executou.

Exemplo

Requer automations:read. status é active, completed ou exited, stepKey restringe a lista às pessoas num passo, e q pesquisa nomes e endereços. limit vai até 200 e assume 50 por omissão.

curl
curl "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments?status=active" -H "$AUTH"curl "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments/aen_2d8f1b6c9e3a47d05b1c8e62" -H "$AUTH"
Resposta
{  "object": "list",  "data": [{      "object": "automation_enrollment",      "id": "aen_2d8f1b6c9e3a47d05b1c8e62",      "automationId": "aut_7c2e9a1f4b8d30c65e1a9f27",      "version": 2,      "contact": { "id": "5b0e7c1a-2f4d-4c8b-9a36-1e7d0c5f8b24", "email": "[email protected]", "name": "Ana Lima" },      "status": "active",      "source": "trigger",      "stepKey": "pause",      "waiting": true,      "waitingForEvent": null,      "heldFor": null,      "nextRunAt": "2026-10-14T08:02:11.000Z",      "exitReason": null,      "lastError": null,      "startedAt": "2026-10-11T08:02:03.000Z",      "finishedAt": null,      "updatedAt": "2026-10-11T08:02:11.000Z"    }],  "hasMore": false,  "nextCursor": null}

waiting é true enquanto a pessoa está num passo de espera, e nextRunAt é quando avança. waitingForEvent indica o evento por que uma espera aguarda.

heldFor diz porque é que um passo que já devia ter corrido ainda não correu: window pelo horário de envio, quota pela quota de envio do plano, lane enquanto o correio de marketing está em pausa no espaço de trabalho, ou retry depois de uma falha.

Uma inscrição lida sozinha acrescenta runs: cada passo executado, com o outcome e, num email, o emailId da mensagem.

Referência