HomeSandbox AccountsAPIApp StudioWebhooksCommunity
API

List all automations

get
https://{youraccountname}.api-us1.com/api/3/automations
{
    "automations": [
        {
            "name": "Email Subscription",
            "cdate": "2018-08-06T16:28:43-05:00",
            "mdate": "2018-08-06T16:33:10-05:00",
            "userid": "1",
            "status": "2",
            "entered": "0",
            "exited": "0",
            "hidden": "0",
            "defaultscreenshot": "http://img-us1.com/default-series.gif",
            "screenshot": "https://d226aj4ao1t61q.cloudfront.net/k0x4h0lr_default-automation.png",
            "links": {
                "campaigns": "https://:account.api-us1.com/api/3/automations/1/campaigns",
                "contactGoals": "https://:account.api-us1.com/api/3/automations/1/contactGoals",
                "contactAutomations": "https://:account.api-us1.com/api/3/automations/1/contactAutomations",
                "blocks": "https://:account.api-us1.com/api/3/automations/1/blocks",
                "goals": "https://:account.api-us1.com/api/3/automations/1/goals",
                "sms": "https://:account.api-us1.com/api/3/automations/1/sms",
                "sitemessages": "https://:account.api-us1.com/api/3/automations/1/sitemessages"
            },
            "id": "1"
        },
        {
            "name": "Test SMS Send",
            "cdate": "2018-09-18T10:46:32-05:00",
            "mdate": "2018-09-18T10:54:30-05:00",
            "userid": "1",
            "status": "1",
            "entered": "2",
            "exited": "2",
            "hidden": "0",
            "defaultscreenshot": "http://img-us1.com/default-series.gif",
            "screenshot": "https://d226aj4ao1t61q.cloudfront.net/k0x4h0lr_default-automation.png",
            "links": {
                "campaigns": "https://:account.api-us1.com/api/3/automations/2/campaigns",
                "contactGoals": "https://:account.api-us1.com/api/3/automations/2/contactGoals",
                "contactAutomations": "https://:account.api-us1.com/api/3/automations/2/contactAutomations",
                "blocks": "https://:account.api-us1.com/api/3/automations/2/blocks",
                "goals": "https://:account.api-us1.com/api/3/automations/2/goals",
                "sms": "https://:account.api-us1.com/api/3/automations/2/sms",
                "sitemessages": "https://:account.api-us1.com/api/3/automations/2/sitemessages"
            },
            "id": "2"
        }
    ],
    "meta": {
        "total": "2",
        "starts": [
            {
                "id": "2",
                "series": "1",
                "type": "subscribe"
            },
            {
                "id": "4",
                "series": "2",
                "type": "subscribe"
            }
        ],
        "filtered": false,
        "smsLogs": []
    }
}
Query Params
int32
≤ 100
Defaults to 20

Number of automations to return. Defaults to 20, and values above 100 are reduced to 100.

int32
Defaults to 0

Number of automations to skip, for paging.

date

When set together with entryDateEnd, return only automations that had at least one run entry between these dates (inclusive). Both parameters are required to apply the window. Day boundaries use the signed-in user's time zone. Each returned automation includes entriesInWindow, the count of runs in that window. meta.entryWindowApplied is true when the window was applied. entered and exited on each row remain all-time totals. When the windowed count cannot complete in time, the response falls back to the normal roster and meta.entryWindowApplied is false.

date

Inclusive end date for the entry window. Must be sent with entryDateStart. Format YYYY-MM-DD.

string

Return only these automations. One id, or several separated by commas. Supersedes limit, which becomes the number of ids given.

Return only automations whose name contains this text.

string

Split automations by whether they are live. A true value (1 or true) returns every automation past draft — active, inactive and paused alike. A false value (0 or false) returns drafts only, not inactive or paused automations. Omit the parameter to return all of them.

string

Set to any non-empty value to return only automations that send a campaign, an SMS or a site message.

string

Return only automations in these folders. One folder id, or several separated by commas. -1 means automations in no folder.

string

Set to any non-empty value to include each automation's block, goal, campaign, label and conversion data alongside the automations themselves.

string

Set to any non-empty value to include a count of automations per status next to the results.

string

Set to any value other than false to mark whether each automation already has a business goal attached.

string

Set to any truthy value when the results are being drawn as the automations map. Once more than 100 automations match, the map cannot render them all, so the results are narrowed to the automations that reference one another through their blocks. Under 100 matches it changes nothing.

string

Filter by the automation's name. A partial match: renew matches Renewal reminder.

string

Filter by the automation's status: 0 draft, 1 active, 2 inactive, 3 paused. Several statuses may be given separated by commas.

string

Filter by whether the automation is hidden. 1 hidden, 0 not. Defaults to 0 when the parameter is omitted, so hidden automations are left out unless they are asked for.

string

Filter by the total number of contacts that have entered the automation.

string

Filter by the total number of contacts that have left the automation.

string

Filter by the automation's created date.

string

Filter by the automation's last modified date.

string

Return only these automations. One id, or several separated by commas.

int32

Return only automations that add or remove this tag id.

string

Return only automations started by these trigger types, separated by commas.

string

Return only automations containing these action block types, separated by commas.

string

Return only automations in the folder with this name.

string
enum

Order by the automation's name.

Allowed:
string
enum

Order by the automation's status.

Allowed:
string
enum

Order by whether the automation is hidden.

Allowed:
string
enum

Order by the total number of contacts that have entered the automation.

Allowed:
string
enum

Order by the total number of contacts that have left the automation.

Allowed:
string
enum

Order by the automation's created date.

Allowed:
string
enum

Order by the automation's last modified date.

Allowed:
string
enum

Order by when the automation was last revised, falling back to its last modified date when it has never been revised. Sent without a direction, this orders descending.

Allowed:
string
enum

Order by the number of contacts currently moving through the automation. Sent without a direction, this orders descending.

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago

Did this page help you?