Skip to main content
GET
Get an automation

Authorizations

Authorization
string
header
required

An API key from Settings → API keys in the inDM app, sent as Authorization: Bearer indm_.... Keys belong to one workspace and carry a scope: read for GET routes and the validate dry run, full for everything. Keep keys on your server; never ship one to a browser or a mobile app.

Path Parameters

automation_id
string<uuid>
required

The automation id from List automations.

Response

The automation.

An automation's full setup: everything Update an automation can change, as it is stored now. The names match the update body, so you can edit what you read and send it back. The one difference: public_replies lists every public reply, where a create or update body sets one as public_reply.

id
string<uuid>
required
Example:

"9a4b1c7e-2d3f-4a5b-8c6d-1e2f3a4b5c6d"

name
string
required
Example:

"Spring guide reel"

status
enum<string>
required
Available options:
draft,
live,
paused
Example:

"live"

trigger
string
required

What fires it, such as comment.

Example:

"comment"

binding
string
required

How it is attached to content: specific for one post, next for the next post the account publishes, any for every post.

Example:

"specific"

account_id
string<uuid>
required
Example:

"6f1c2a9e-3b7d-4e21-9a55-0c8d2f4b7e10"

keywords
string[]
required

The words that trigger it, as stored.

Example:
dm_sent_count
integer
required

DMs this automation has sent since it was created.

Example:

182

created_at
string<date-time>
required
Example:

"2026-11-05T09:02:11Z"

updated_at
string<date-time>
required
Example:

"2026-11-05T09:04:30Z"

dm_message
string
required

The message carrying the link. With an opener, this is the second message.

Example:

"Here's the spring planting guide. Enjoy it."

button_label
string
required

The opt-in button's label.

Example:

"Send me the guide"

public_replies
string[]
required

The public replies inDM posts under a fan's comment, one per comment. Empty when there are none.

Example:

The links the DM delivers, in the order the fan sees them. Empty when there are none.

opener_message
string
required

The opt-in message sent first. Empty when there is no opener.

Example:

""

opener_plain_text
boolean
required

Whether the opener is sent as plain text with no button.

Example:

false

follow_gate
boolean
required

Whether the fan is asked to follow before the link arrives.

Example:

false

email_gate
boolean
required

Whether the fan is asked for an email address before the link arrives.

Example:

false

follow_gate_message
string
required

Your own words for the follow ask. Empty when inDM's wording is used.

Example:

""

follow_gate_visit_label
string
required

The label on the button that opens your profile. Empty for inDM's.

Example:

""

follow_gate_following_label
string
required

The label on the button a fan taps once they follow. Empty for inDM's.

Example:

""

email_gate_message
string
required

Your own words for the email ask. Empty when inDM's wording is used.

Example:

""

followup_message
string
required

The second message sent later. Empty when there is no follow-up.

Example:

""

followup_delay_minutes
integer
required

How long after the first message the follow-up goes out. 0 when there is no follow-up.

Example:

0

media_id
string<uuid>

The post it is attached to. Present when binding is specific.

Example:

"3d2a7f10-9c4e-4b8a-a1f2-6e0b5d7c9a31"