List follow-up sequences
Lists the follow-up sequences of the account with their steps. A sequence sends messages after a contact confirmed the opt-in. Returns sequences, oldest first; use get_followup_sequence for one.
GET /v1/followup-sequences
| Permission | followups: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_followup_sequences |
| 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 sequences with this status. one of: draft, active, paused |
#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. - Sorting: newest first (
created_atdescending, theniddescending); no other order.
#Examples
curl "https://api.smartchat.marketing/v1/followup-sequences?limit=2" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY"import os
import requests
response = requests.get(
"https://api.smartchat.marketing/v1/followup-sequences",
headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
params={
"limit": "2",
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/followup-sequences?limit=2", {
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": "followup_sequence",
"id": "fup_7b1d3f5a9c2e4a6b8d0f1e3c5a7b9d2f",
"name": "Welcome series",
"trigger": "signup",
"status": "draft",
"steps": [
{
"object": "followup_step",
"id": "stp_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
"position": 1,
"delay_minutes": 1440,
"text": "Hi {{first_name}}, thanks for joining. Here is what to expect from us.",
"template_id": null,
"template_status": null,
"send_time": null
},
{
"object": "followup_step",
"id": "stp_6f5e4d3c2b1a4f9e8d7c6b5a4f3e2d1c",
"position": 2,
"delay_minutes": 4320,
"text": "Hi {{first_name}}, a quick tip for you this week.",
"template_id": null,
"template_status": null,
"send_time": null
}
],
"created_at": "2026-10-25T09:41:07Z"
}
],
"has_more": false,
"next_cursor": null,
"url": "/v1/followup-sequences"
}#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 "followup_sequence". always followup_sequence |
data[].id | string | Sequence ID. |
data[].name | string | Name of the sequence. up to 200 characters |
data[].trigger | string | What starts the sequence. Today: signup (after the opt-in confirmation). up to 40 characters |
data[].status | string | draft and paused send nothing. active sends. one of: draft, active, paused |
data[].steps | array of object | The steps in order. up to 100 items |
data[].steps[].object | string | Always "followup_step". always followup_step |
data[].steps[].id | string | Step ID. |
data[].steps[].position | integer | Order of the step, starting at 1. 1 to 100 |
data[].steps[].delay_minutes | integer | Wait before this step. For step 1 the wait after the opt-in confirmation, for later steps the wait after the step before. 0 to 525600 |
data[].steps[].text | string | Message text of the step. up to 20000 characters |
data[].steps[].template_id | string or null | ID of the template that carries this step, or null if none exists yet. up to 36 characters |
data[].steps[].template_status | string or null | Approval state of that template. one of: draft, pending, approved, rejected, paused, disabled, null |
data[].steps[].send_time | string or null | Time of day HH:MM for this step, or null for the account default. up to 5 characters |
data[].created_at | string | When the sequence was created. 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>'. |
account_blocked | 403 | This account is blocked. |
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. |
service_unavailable | 503 | The service is temporarily unavailable. |
All errors use one format.