ドキュメント本文へスキップ
API

オートメーション内の人

オートメーションに入った人を新しい順に、それぞれが今いるステップとともに返します。id で読み取った 1 件の参加状況には、実行したすべてのステップも含まれます。

GET/automations/{id}/enrollments

2件の呼び出しをワークスペースに対して実行します。

GET /automations/{id}/enrollments

オートメーションに入った人を新しい順に、それぞれが今いるステップとともに返します。id で読み取った 1 件の参加状況には、実行したすべてのステップも含まれます。

例

automations:read が必要です。status は active、completed、exited のいずれかで、stepKey は一覧を 1 つのステップにいる人に絞り込み、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 は失敗後の再試行です。

参加状況を 1 件だけ取得すると runs が加わります。実行した各ステップと、その outcome、メールの場合はメッセージの emailId です。

リファレンス