Get sequences

Returns one of the caller org's sequences together with its steps in send order.

GET /v1/marketing/sequences/{id}

Marketing → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/marketing/sequences/{id}`
Method	`GET`
Operation	`get_marketing_sequences_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one of the caller org's sequences together with its steps in send order. A sequence belonging to another org reads as not found.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the sequence id from the path, as returned by create.

Response

Status	Body	Meaning
`200`	SequenceView	ok

200 body — 14 fields.

Field	In	Type	Always	Description
`sequence`	body	Sequence	—
`sequence.createdAt`	body	integer	—	CreatedAt is unix seconds when the sequence was registered, server-assigned and never rewritten.
`sequence.id`	body	string	—	ID is the server-assigned sequence id ("seq_" + 128 random bits).
`sequence.name`	body	string	—	Name is the sequence's label.
`sequence.status`	body	string	—	Status is the lifecycle: draft, active or archived.
`sequence.updatedAt`	body	integer	—	UpdatedAt is unix seconds of the last status flip, server-assigned, and the key the sequence list is ordered by (newest first).
`steps`	body	Step[]	—	Steps are in send order (idx ascending); empty for a sequence with no messages yet, which enrolls fine and completes immediately.
`steps[].body`	body	string	—	Body is the message text.
`steps[].createdAt`	body	integer	—	CreatedAt is unix seconds, server-assigned.
`steps[].delaySeconds`	body	integer	—	DelaySeconds is how long after the previous step this one sends (after enrollment, for step 0).
`steps[].id`	body	string	—	ID is the server-assigned step id ("step_" + 128 random bits).
`steps[].idx`	body	integer	—	Idx is the step's 0-based position, assigned by appending: a new step always lands after the last one.
`steps[].sequenceId`	body	string	—	SequenceID is the sequence this step belongs to.
`steps[].subject`	body	string	—	Subject is the email subject line, capped at 1024 bytes.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing sequences get <id>

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingSequencesById({ 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(id='id')

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.GetMarketingSequencesById(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(&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).getMarketingSequencesById();

curl https://api.hanzo.ai/v1/marketing/sequences/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches marketing through the marketing tool, which names its 35 operations with its own verbs — this one among them, under a name only MCP 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"
         }
       }
     }'

Marketing API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page