Hanzo
OpenapiMarketing

Returns who is walking one sequence, most recently enrolled first, with each…

Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.

GET /v1/marketing/sequences/{id}/enrollments

Addresshttps://api.hanzo.ai/v1/marketing/sequences/{id}/enrollments
MethodGET
Operationget_marketing_sequences_by_id_enrollments
AuthAuthorization: Bearer $HANZO_API_KEY

Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.

Request

2 fields.

FieldInTypeRequiredDescription
idpathstringyesID is the sequence id from the path.
limitqueryintegerLimit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Response

StatusBodyMeaning
200EnrollmentListok

200 body — 10 fields.

FieldInTypeAlwaysDescription
databodyEnrollment[]Data is the page: every contact walking this ONE sequence, in any state — active, completed and canceled walks all appear, since the history of who was reached…
data[].addressbodystringAddress is the normalized (lower-cased, trimmed) recipient.
data[].channelbodystringChannel is the delivery surface the steps go out on.
data[].currentStepbodyintegerCurrentStep is the index of the step that sends next.
data[].enrolledAtbodyintegerEnrolledAt is unix seconds when the contact joined the walk, and orders the enrollment list (newest first).
data[].idbodystringID is the server-assigned enrollment id ("enr_" + 128 random bits).
data[].nextRunAtbodyintegerNextRunAt is the unix time the current step comes due; 0 once the walk has ended.
data[].sequenceIdbodystringSequenceID is the sequence being walked.
data[].statusbodystringStatus is active, completed or canceled.
data[].updatedAtbodyintegerUpdatedAt is unix seconds of the last move: the drip engine writes it each time it advances the walk a step, completes it or cancels it.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing sequences enrollments list <id>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page