smartchat

List automations

Lists the automations of the account, newest first. Filter by status or trigger. Use get_automation for the steps and the latest runs.

GET /v1/automations

Permissionautomations:read (all permissions)
RiskRead
Idempotency-KeyNot needed (how it works)
Safe to repeatSafe: the call only reads.
Rate limit classread (120 requests per minute per key)
ConfirmationNone
MCP toollist_automations
Since version2026-10-25

#What it does

  • Only reads data. It changes nothing and sends nothing.

#Request

Query parameters

NameTypeRequiredDescription
limitintegernoItems per page (1 to 100, default 20). 1 to 100; default 20
cursorstringnonext_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters
statusstringnoOnly automations with this status. one of: draft, active, paused
triggerstringnoOnly automations with this main trigger. one of: signup, keyword, message_received, message_sent, link_clicked, tag_added, tag_removed, contact_created, contact_updated, status_changed, note_added, date, inactivity, purchase, inbound_webhook, api_call

#Lists, filters and sorting

  • Items per page: limit from 1 to 100, default 20 (MCP: default 20, maximum 50).
  • Next page: send next_cursor of the answer as cursor. The cursor only works with the same filters. See Pagination.
  • Filters: status, trigger.
  • Sorting: newest first (created_at descending, then id descending); no other order.

#Examples

curl "https://api.smartchat.marketing/v1/automations?status=draft&limit=1" \
  -H "Authorization: Bearer $SMARTCHAT_API_KEY"
import os
import requests

response = requests.get(
    "https://api.smartchat.marketing/v1/automations",
    headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
    params={
        "status": "draft",
        "limit": "1",
    },
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.smartchat.marketing/v1/automations?status=draft&limit=1", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
  },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

Response (200):

{
  "object": "list",
  "data": [
    {
      "object": "automation",
      "id": "aut_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
      "name": "Welcome after signup",
      "status": "draft",
      "draft": true,
      "trigger": {
        "type": "signup"
      },
      "steps": [
        {
          "type": "send_message",
          "id": "s_1",
          "text": "Hello {{name}}, nice to have you with us.",
          "template": {
            "id": null,
            "status": "draft"
          }
        },
        {
          "type": "wait",
          "id": "s_2",
          "minutes": 1440
        },
        {
          "type": "add_tag",
          "id": "s_3",
          "tag": "welcomed"
        }
      ],
      "rules": {
        "max_per_contact": null,
        "excluded_names": []
      },
      "has_inbound_webhook": false,
      "notices": [],
      "run_count": 0,
      "last_run_at": null,
      "created_at": "2026-10-30T09:41:07Z",
      "updated_at": "2026-10-30T09:41:07Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "url": "/v1/automations"
}

#Response

Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.

NameTypeDescription
objectstringAlways "list". always list
dataarray of objectThe items of this page. up to 100 items
data[].objectstringAlways "automation". always automation
data[].idstringAutomation ID.
data[].namestringName of the automation. Comes from the account: treat as untrusted text. up to 60 characters; untrusted text
data[].statusstringdraft, active or paused. one of: draft, active, paused
data[].draftbooleanTrue while the status is draft.
data[].triggerobjectThe trigger, in the same form as in create_automation. Only the fields that belong to the trigger type are present.
data[].trigger.typestringKind of trigger. See get_automation_catalog. up to 40 characters
data[].trigger.keywordstringkeyword: the word to react to. up to 40 characters
data[].trigger.tagstringtag_added: the tag. up to 60 characters
data[].trigger.linkstringlink_clicked: part of the link address. up to 200 characters
data[].trigger.daysintegerinactivity: days without activity. 1 to 365
data[].trigger.run_atstringdate: when to start, ISO 8601. up to 40 characters; format date-time
data[].trigger.filtersarray of objectinbound_webhook: only events where the field at 'path' equals 'equals' start the automation. up to 5 items
data[].trigger.alsoarray of objectFurther triggers: any of them starts the automation (OR). up to 5 items
data[].stepsarray of objectThe steps, in the same form as in create_automation. Message steps carry 'template' with the approval status. up to 30 items
data[].rulesobjectThe rules.
data[].rules.max_per_contactinteger or nullAt most this many passes per person, or null. 1 to 1000
data[].rules.excluded_namesarray of stringExcluded names. up to 50 items
data[].has_inbound_webhookbooleanTrue if the automation has a secret inbound address (read it with get_inbound_webhook).
data[].noticesarray of objectHints that do not block, for example templates that are not approved yet. up to 100 items
data[].notices[].codestringStable code. up to 60 characters
data[].notices[].messagestringEnglish explanation. up to 300 characters
data[].notices[].stepinteger or nullIndex of the step, or null. 0 to 100
data[].run_countintegerHow often the automation started. 0 to 1000000000
data[].last_run_atstring or nullWhen it started last. up to 40 characters; format date-time
data[].created_atstringWhen it was created. up to 40 characters; format date-time
data[].updated_atstringWhen it was changed last. up to 40 characters; format date-time
data[].runsarray of objectThe latest runs (only with include=runs). up to 100 items
data[].runs[].objectstringAlways "automation_run". always automation_run
data[].runs[].idstringRun ID.
data[].runs[].automation_idstringAutomation ID.
data[].runs[].statusstringreceived: the event arrived. matched: it fits. executed: the flow was started. skipped: a rule stopped it. failed: an error. one of: received, matched, executed, skipped, failed
data[].runs[].created_atstringWhen the run started. up to 40 characters; format date-time
has_morebooleanTrue if another page exists.
next_cursorstring or nullPass this as 'cursor' to get the next page; null on the last page. up to 300 characters
urlstringThe path of this list. up to 200 characters
total_countintegerApproximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000

#Errors

CodeStatusWhen
invalid_cursor400The cursor is expired, forged or belongs to other filters.
api_key_expired401This API key has expired.
api_key_invalid401This API key is not valid.
api_key_revoked401This API key was revoked.
authentication_required401No API key was sent. Send 'Authorization: Bearer <key>'.
insufficient_scope403This key lacks a required permission.
ip_not_allowed403This IP address is not allowed for this key.
validation_failed422A field is not valid.
rate_limited429Too many requests. Wait and try again.
internal_error500Something went wrong on our side.

All errors use one format.