API Reference

Retrieve Automation

GET /automations/:id — retrieve one automation with its steps, connections, and enrollment counts.

GET/automations/:id

Retrieves a single automation. Unlike the list, this returns the full object — steps (the trigger step first, then the executable steps), connections, and enrollments (an object with active and completed counts).

Path parameters

idstringrequired

The ID of the automation to retrieve.

import { MailBlastr } from 'mailblastr';

const mb = new MailBlastr('mb_xxxxxxxxx');

const { data, error } = await mb.automations.get('c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd');
console.log({ data, error });

Response

{
  "object": "automation",
  "id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd",
  "audience_id": "aud_3b1c...",
  "domain": "yourdomain.com",
  "name": "Welcome series",
  "trigger": "user.created",
  "status": "enabled",
  "steps": [
    {
      "key": "start",
      "type": "trigger",
      "config": { "event_name": "user.created" }
    },
    {
      "id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
      "key": "welcome",
      "type": "send_email",
      "position": 0,
      "config": {
        "template": { "id": "34a080c9-b17d-4187-ad80-5af20266e535" }
      }
    }
  ],
  "connections": [
    { "from": "start", "to": "welcome", "type": "default" }
  ],
  "enrollments": { "active": 12, "completed": 48 },
  "created_at": "2026-06-23T10:00:00.000Z",
  "updated_at": "2026-06-23T10:00:00.000Z"
}

An unknown id returns 404 not_found. See Errors.