Skip to content
Dashboard

List Instagram automations

GET
/instagram/automations
curl --request GET \
--url https://app.whatsetter.com/api/v1/instagram/automations \
--header 'Authorization: Bearer <token>'

The workspace’s Instagram automations (the dashboard’s « Automatisations »), each with what fires it, what it answers, the agent that continues, whether it is active, and its numbers (stats: times it fired, private messages sent, links opened, last time it fired). trigger.on is ref_link for an automation made in the dashboard on an ig.me link. Requires scope instagram:read.

account_id
string

One Instagram account of the workspace (all of them by default).

The automations

Media typeapplication/json
object
data
Array<object>
object
id
string
account_id
string
name
string
active
boolean
trigger
object
on

What fires it. Read back, ref_link is an automation made in the dashboard on an ig.me link.

string
Allowed values: comment story_reply story_mention dm
posts
One of:
string
Allowed values: all next
keywords

One of these words fires it (accents and case ignored).

Array<string>
<= 30 items
any_word

Every comment or message fires it

boolean
public_replies
Array<string>
dm_message
string
link
object
url
string
label
string | null
ask_label
string | null
title
string | null
follow_gate
object
message
string
button_label
string
success_message
string
campaign_id

The agent that continues (its campaign_id).

string | null
ai_handoff
boolean
stats
object
fired

Times it fired

integer
dms_sent

Private messages it sent.

integer
link_clicks

People who opened its link (once per person).

integer
last_fired_at
string | null format: date-time
created_at
string | null format: date-time
Example
{
"data": [
{
"id": "6900a1b2c3d4e5f6a7b8c9d0",
"account_id": "68f1c2d3e4f5a6b7c8d9e0f1",
"name": "Buyer's guide",
"active": true,
"trigger": {
"on": "comment",
"posts": "next",
"keywords": [
"GUIDE"
],
"any_word": false
},
"public_replies": [
"Sent you a DM 👀"
],
"dm_message": "Here is the guide 👇",
"link": {
"url": "https://example.com/guide",
"label": "Get the guide",
"ask_label": null,
"title": null
},
"follow_gate": null,
"campaign_id": "instagram-acme-studio-x7k2",
"ai_handoff": true,
"stats": {
"fired": 240,
"dms_sent": 231,
"link_clicks": 88,
"last_fired_at": "2026-10-30T16:12:09.000Z"
},
"created_at": "2026-10-20T09:00:00.000Z"
}
]
}

Missing, unknown or revoked API key

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

The key lacks the required scope (insufficient_scope), the plan does not have this part of the API (not_in_plan), or Instagram is not enabled on the workspace (instagram_not_enabled, Instagram routes)

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Resource not found in this workspace

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}