Skip to content
Dashboard

List Instagram accounts

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

The workspace’s connected Instagram accounts: the id every Instagram route takes as account_id, the status (connected, or needs_reconnect when the connection expired or was revoked), what each account may do (grants: messages, publishing, insights; an account connected before publishing and insights were offered must be reconnected from the dashboard for them), the Facebook Page linked to it and whether that Page allows publishing, its agent (the campaign_id that answers, whether it is on, whether it answers every private message or only the people an automation brought), « Le tri » (when the agent answers every private message: which messages it answers anyway) and human_pause_hours (how long a person’s reply pauses the agent on a lead; 0 = never). No token is ever returned. Requires scope instagram:read.

The connected accounts

Media typeapplication/json
object
data
Array<object>
object
id

The account_id the Instagram routes take.

string
username
string | null
name
string | null
status

needs_reconnect: the connection expired or was revoked; reconnect it from the dashboard.

string
Allowed values: connected needs_reconnect
grants

What the account’s permissions allow. An account connected before publishing and insights were offered has neither publish nor insights until it is reconnected.

object
messages

Read and answer private messages.

boolean
publish

Publish and schedule posts from WhatSetter.

boolean
insights

Views

boolean
facebook_page

The Facebook Page linked to the account (Messenger, « Also on Facebook »), null when none.

object
name
string | null
can_publish

The Page allows publishing (facebook: true on a post).

boolean
agent
object
campaign_id

The agent that answers on this account (GET /campaigns).

string | null
enabled

The agent answers on this account.

boolean
all_dms

True: it answers every private message; false: only the people an automation brought.

boolean
triage

The triage (« What the agent leaves aside » in the dashboard): when the agent answers every private message, which messages it answers anyway. Spam is never answered.

object
enabled

The agent is on and answers every private message.

boolean
answer_collab

False: a brand or a partnership is left for the owner.

boolean
answer_support

False: a customer with a problem is left for the owner.

boolean
answer_personal

False: thanks, compliments and chat get no reply.

boolean
human_pause_hours

How long a person’s reply (dashboard, Instagram app or API) pauses the agent on a lead, in hours. 0 = never.

integer
Example
{
"data": [
{
"id": "68f1c2d3e4f5a6b7c8d9e0f1",
"username": "acme.studio",
"name": "Acme Studio",
"status": "connected",
"grants": {
"messages": true,
"publish": true,
"insights": true
},
"facebook_page": {
"name": "Acme Studio",
"can_publish": true
},
"agent": {
"campaign_id": "instagram-acme-studio-x7k2",
"enabled": true,
"all_dms": true
},
"triage": {
"enabled": true,
"answer_collab": false,
"answer_support": false,
"answer_personal": false
},
"human_pause_hours": 24
}
]
}

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"
}
}