Skip to main content
GET
Retrieve Automation Enrollment

인증

Authorization
string
header
필수

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

automation:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

Automation enrollment ID, prefixed atoe_.

응답

Automation enrollment details

account_id
string
필수

ID of the account the automation belongs to, prefixed biz_.

예시:

"biz_xxxxxxxxxxxxxx"

automation_id
string
필수

ID of the automation, prefixed ato_.

예시:

"ato_xxxxxxxxxxxxxx"

created_at
string
필수

When the member enrolled, as an ISO 8601 timestamp.

예시:

"2026-01-01T12:00:00.000Z"

ended_at
string | null
필수

When the enrollment ended, as an ISO 8601 timestamp. null while it's active.

예시:

"2026-01-01T12:00:00.000Z"

id
string
필수

Automation enrollment ID, prefixed atoe_.

예시:

"atoe_xxxxxxxxxxxxxx"

member_id
string
필수

ID of the member in the automation, prefixed mber_.

예시:

"mber_xxxxxxxxxxxxxx"

next_run_at
string | null
필수

When that step runs for this member, as an ISO 8601 timestamp. null once the enrollment ends.

예시:

"2026-01-01T12:00:00.000Z"

next_step_id
string | null
필수

ID of that step in the member's version, prefixed atos_. null once the enrollment ends.

예시:

"atos_xxxxxxxxxxxxxx"

next_step_key
integer | null
필수

The key of the step the member is waiting on, in their version. null once the enrollment ends.

예시:

1

status
enum<string>
필수

active while the member moves through the automation. completed after its last step. canceled when the account canceled the enrollment, or stopped or deleted the automation.

사용 가능한 옵션:
active,
completed,
canceled
예시:

"active"

trigger_event
enum<string> | null
필수

The webhook event that enrolled the member. null when POST /automations/{id}/trigger enrolled them.

사용 가능한 옵션:
payment.succeeded,
payment.failed,
membership.activated,
membership.trial_ending_soon,
member.created,
invoice.created,
invoice.paid,
invoice.past_due,
refund.created,
dispute.created,
resolution_center_case.created,
resolution_center_case.decided,
course_lesson_interaction.completed,
null
예시:

"payment.succeeded"

trigger_resource_id
string | null
필수

ID of the record the triggering event was about, such as a pay_ payment or mem_ membership. null when a trigger request enrolled them.

예시:

"mber_xxxxxxxxxxxxxx"

updated_at
string
필수

When the enrollment last changed, as an ISO 8601 timestamp.

예시:

"2026-01-01T12:00:00.000Z"

user_id
string | null
필수

ID of the member's user, prefixed user_. null when the member is another business.

예시:

"user_xxxxxxxxxxxxxx"

version
integer
필수

The automation version the member is on. It changes only when a publish moves members to the new version.

예시:

1