List automations

GET

/api/v3/automations

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/automations?api=true' \
  --header 'Authorization: Bearer <token>'

• Production

List your company’s automations (Automation Series), with each one’s status, channel, schedule, and the segment and template it sends. Filter by status, channels, or a keyword search against the title, and sort with orderBy/direction.

A note on this response

Each item includes the automation’s and its channel’s and newsletter’s internal numeric ids (channelId, newsletterId) alongside the usual slugs and unique id. This reference documents the response as the API actually returns it today.

v3 endpoints expect a company API key.

Authorizations

• bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

keyword

string

Optional. Restrict the list to automations whose title contains this text.

status

integer

Optional. Restrict the list to automations in this status: 0=draft, 1=running, 2=paused, 5=processing, 9=error. Omit to return automations in any status.

channels

Array<string>

Optional. Restrict the list to automations on these channel slugs.

orderBy

string

Optional. Sort field: createdAt, updatedAt, title, status, channel, or next. Defaults to createdAt.

direction

string

Optional. Sort direction, asc or desc. Defaults to desc.

page

integer

Optional. Page number, starting at 1. Defaults to 1.

limit

integer

Optional. Results per page. Defaults to 10.

Responses

200

200 OK

Media type application/json

object

items

Array<object>

object

uniqueId

string

title

string

status

0=draft, 1=running, 2=paused, 5=processing, 9=error.

integer

type

0=scheduled series, 1=triggered on a new subscriber.

integer

actions

The steps this automation runs, each naming the template it sends.

Array<object>

object

templateId

string

type

integer

channel

string

channelId

integer

channelSlug

string

newsletterId

integer

organizationSlug

string

segmentId

integer

segmentName

string

templateName

string

titleMode

integer

manualTitle

string

nullable

previewTextMode

integer

manualPreviewText

string

nullable

hasDynamicTitle

boolean

hasDynamicPreviewText

boolean

isAutopilot

boolean

frequency

object

daysOfWeek

Array<integer>

time

string

weeksInterval

integer

next

string

nullable

previous

string

nullable

validationCode

integer

nullable

createdAt

string

updatedAt

string

message

string

total

integer

Example

{
  "items": [
    {
      "uniqueId": "abcdefhik",
      "title": "Welcome Series - Step 1",
      "status": 1,
      "type": 0,
      "actions": [
        {
          "templateId": "xyz12345",
          "type": 0
        }
      ],
      "channel": "An Example Channel",
      "channelId": 101,
      "channelSlug": "an-example-channel",
      "newsletterId": 555,
      "organizationSlug": "example-org",
      "segmentId": 42,
      "segmentName": "All Subscribers",
      "templateName": "Welcome Email",
      "titleMode": 0,
      "manualTitle": null,
      "previewTextMode": 0,
      "manualPreviewText": null,
      "hasDynamicTitle": false,
      "hasDynamicPreviewText": false,
      "isAutopilot": false,
      "frequency": {
        "daysOfWeek": [
          1
        ],
        "time": "09:00",
        "weeksInterval": 1
      },
      "next": "2026-08-27 09:00:00",
      "previous": "2026-08-20 09:00:00",
      "validationCode": null,
      "createdAt": "2026-01-05 12:00:00",
      "updatedAt": "2026-08-20 09:05:00"
    }
  ],
  "message": "Automations fetched successfully.",
  "total": 1
}