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
| Address | https://api.hanzo.ai/v1/marketing/sequences/{id}/enrollments |
| Method | GET |
| Operation | get_marketing_sequences_by_id_enrollments |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the sequence id from the path. |
limit | query | integer | — | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | EnrollmentList | ok |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | Enrollment[] | — | 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[].address | body | string | — | Address is the normalized (lower-cased, trimmed) recipient. |
data[].channel | body | string | — | Channel is the delivery surface the steps go out on. |
data[].currentStep | body | integer | — | CurrentStep is the index of the step that sends next. |
data[].enrolledAt | body | integer | — | EnrolledAt is unix seconds when the contact joined the walk, and orders the enrollment list (newest first). |
data[].id | body | string | — | ID is the server-assigned enrollment id ("enr_" + 128 random bits). |
data[].nextRunAt | body | integer | — | NextRunAt is the unix time the current step comes due; 0 once the walk has ended. |
data[].sequenceId | body | string | — | SequenceID is the sequence being walked. |
data[].status | body | string | — | Status is active, completed or canceled. |
data[].updatedAt | body | integer | — | UpdatedAt 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>import { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingSequencesByIdEnrollments({ id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).get_marketing_sequences_by_id_enrollments(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.GetMarketingSequencesByIdEnrollments(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, marketing_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = marketing_api::get_marketing_sequences_by_id_enrollments(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new MarketingApi(client).getMarketingSequencesByIdEnrollments();curl https://api.hanzo.ai/v1/marketing/sequences/<id>/enrollments \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches marketing through the marketing tool, which names its 35 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_marketing_audiences"
}
}
}'How is this guide?