Перейти к документации
API

Люди в автоматизации

Люди, которые вошли в автоматизацию, сначала новые, с шагом, на котором находится каждый. Одно участие, прочитанное по id, содержит ещё и все выполненные шаги.

GET/automations/{id}/enrollments

Выполняет любой из 2 запросов в вашем рабочем пространстве.

GET /automations/{id}/enrollments

Люди, которые вошли в автоматизацию, сначала новые, с шагом, на котором находится каждый. Одно участие, прочитанное по id, содержит ещё и все выполненные шаги.

Пример

Требуется automations:read. status принимает active, completed или exited, stepKey сужает список до людей на одном шаге, а q ищет по именам и адресам. limit доходит до 200, по умолчанию 50.

curl
curl "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments?status=active" -H "$AUTH"curl "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments/aen_2d8f1b6c9e3a47d05b1c8e62" -H "$AUTH"
Ответ
{  "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, пока человек находится на шаге ожидания, а nextRunAt показывает, когда он пойдёт дальше. waitingForEvent называет событие, которого ждёт ожидание.

heldFor объясняет, почему шаг, срок которого наступил, ещё не выполнен: window из-за окна отправки, quota из-за лимита отправок тарифа, lane, пока маркетинговые письма рабочего пространства приостановлены, или retry после сбоя.

Отдельное участие добавляет runs: каждый выполненный шаг с его outcome и, для письма, emailId сообщения.

Справочник