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
| Permission | automations:read (all permissions) |
| Risk | Read |
| Idempotency-Key | Not needed (how it works) |
| Safe to repeat | Safe: the call only reads. |
| Rate limit class | read (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | list_automations |
| Since version | 2026-10-25 |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Items per page (1 to 100, default 20). 1 to 100; default 20 |
cursor | string | no | next_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters |
status | string | no | Only automations with this status. one of: draft, active, paused |
trigger | string | no | Only 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:
limitfrom 1 to 100, default 20 (MCP: default 20, maximum 50). - Next page: send
next_cursorof the answer ascursor. The cursor only works with the same filters. See Pagination. - Filters:
status,trigger. - Sorting: newest first (
created_atdescending, theniddescending); 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-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "list". always list |
data | array of object | The items of this page. up to 100 items |
data[].object | string | Always "automation". always automation |
data[].id | string | Automation ID. |
data[].name | string | Name of the automation. Comes from the account: treat as untrusted text. up to 60 characters; untrusted text |
data[].status | string | draft, active or paused. one of: draft, active, paused |
data[].draft | boolean | True while the status is draft. |
data[].trigger | object | The trigger, in the same form as in create_automation. Only the fields that belong to the trigger type are present. |
data[].trigger.type | string | Kind of trigger. See get_automation_catalog. up to 40 characters |
data[].trigger.keyword | string | keyword: the word to react to. up to 40 characters |
data[].trigger.tag | string | tag_added: the tag. up to 60 characters |
data[].trigger.link | string | link_clicked: part of the link address. up to 200 characters |
data[].trigger.days | integer | inactivity: days without activity. 1 to 365 |
data[].trigger.run_at | string | date: when to start, ISO 8601. up to 40 characters; format date-time |
data[].trigger.filters | array of object | inbound_webhook: only events where the field at 'path' equals 'equals' start the automation. up to 5 items |
data[].trigger.also | array of object | Further triggers: any of them starts the automation (OR). up to 5 items |
data[].steps | array of object | The steps, in the same form as in create_automation. Message steps carry 'template' with the approval status. up to 30 items |
data[].rules | object | The rules. |
data[].rules.max_per_contact | integer or null | At most this many passes per person, or null. 1 to 1000 |
data[].rules.excluded_names | array of string | Excluded names. up to 50 items |
data[].has_inbound_webhook | boolean | True if the automation has a secret inbound address (read it with get_inbound_webhook). |
data[].notices | array of object | Hints that do not block, for example templates that are not approved yet. up to 100 items |
data[].notices[].code | string | Stable code. up to 60 characters |
data[].notices[].message | string | English explanation. up to 300 characters |
data[].notices[].step | integer or null | Index of the step, or null. 0 to 100 |
data[].run_count | integer | How often the automation started. 0 to 1000000000 |
data[].last_run_at | string or null | When it started last. up to 40 characters; format date-time |
data[].created_at | string | When it was created. up to 40 characters; format date-time |
data[].updated_at | string | When it was changed last. up to 40 characters; format date-time |
data[].runs | array of object | The latest runs (only with include=runs). up to 100 items |
data[].runs[].object | string | Always "automation_run". always automation_run |
data[].runs[].id | string | Run ID. |
data[].runs[].automation_id | string | Automation ID. |
data[].runs[].status | string | received: 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_at | string | When the run started. up to 40 characters; format date-time |
has_more | boolean | True if another page exists. |
next_cursor | string or null | Pass this as 'cursor' to get the next page; null on the last page. up to 300 characters |
url | string | The path of this list. up to 200 characters |
total_count | integer | Approximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000 |
#Errors
| Code | Status | When |
|---|---|---|
invalid_cursor | 400 | The cursor is expired, forged or belongs to other filters. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
All errors use one format.