List automations

Returns the org's automations.

GET /v1/auto/automations

Addresshttps://api.hanzo.ai/v1/auto/automations
MethodGET
Operationget_auto_automations
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's automations. q keeps those whose name or instructions contain it, ignoring case; sort is updated (the default, newest first), name, or next (soonest first, unscheduled last).

Request

2 fields.

FieldInTypeRequiredDescription
qquerystring—Q keeps the automations whose name or instructions contain it, ignoring case.
sortquerystring—Sort is name, next or updated (the default, newest first).

Response

StatusBodyMeaning
200auto.automationPageok
defaultproblem-detailsrefused

200 body — 25 fields.

FieldInTypeAlwaysDescription
databodyauto.Automation[]—Data is the org's automations.
data[].createdbodystring—Created and Updated are RFC 3339 UTC.
data[].draftbodyboolean—Draft is a flow with no step yet: it has no instructions, never runs, and becomes an automation when its instructions are saved.
data[].enabledbodyboolean—Enabled is whether its schedule is armed.
data[].idbodystring—ID is the automation's id, which is also its flow's.
data[].instructionsbodystring—Instructions are what the agent is asked to do each run.
data[].lastbodyauto.LastRun—
data[].last.atbodystring—
data[].last.idbodystring—
data[].last.statusbodystring—Status is succeeded, failed, running or queued.
data[].last.summarybodystring—
data[].modelbodystring—Model is the model the agent thinks with; null for the default.
data[].namebodystring—Name is what it is called.
data[].nextbodystring—Next is when it runs next, RFC 3339 UTC; null when manual or disabled.
data[].notifybodyboolean—Notify sends a one-line summary to the automation's person when a run ends.
data[].permissionsbodystring—Permissions is auto (works and uses connectors without stopping) or ask (changes nothing and ends with the actions it proposes; agent.go agentTask).
data[].postTobodystring[]—PostTo are the connected accounts each run's answer is posted to — x, linkedin, facebook — after review when Permissions is ask (post.go).
data[].projectbodystring—Project is the Dev project the run works in, by its slug; null for none.
data[].schedulebodyauto.Schedule—
data[].schedule.atbodystring—At is the local time, HH:MM on a 24-hour clock, for daily, weekdays and weekly.
data[].schedule.cronbodystring—Cron is a five-field cron expression (minute hour day-of-month month day-of-week), for kind cron only, read in TZ.
data[].schedule.daybodystring—Day is the weekday a weekly schedule runs on: mon, tue, wed, thu, fri, sat or sun.
data[].schedule.kindbodystring—Kind is manual, hourly, daily, weekdays, weekly or cron.
data[].schedule.tzbodystring—TZ is the IANA time zone every time here is read in.
data[].updatedbodystring—

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, AutoApi } from 'hanzoai';

const api = new AutoApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAutoAutomations();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AutoApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AutoApi(client).get_auto_automations()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AutoAPI.GetAutoAutomations(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, auto_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = auto_api::get_auto_automations(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AutoApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AutoApi(client).getAutoAutomations();
curl https://api.hanzo.ai/v1/auto/automations \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches auto through the auto tool, which names its 14 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_auto_flows"
         }
       }
     }'

Auto API · All Hanzo APIs · Interactive reference

Was this page useful?