List automations
Automations of the site in ascending order of id (order=newest for the latest first), each in the shape get_automation returns: its name, whether it is on (is_active), trigger, entry condition, steps in order with their settings and own conditions, folder and author. Call it to find an automation and its id. Filters combine: every one given must match. Deleted automations and follow-ups of widgets are not listed.
Lists keep their first 5 entries and texts their first 200 characters (links, trigger, conditions and steps stay whole); truncated names what was cut, get_automation has it whole.
A page holds up to limit automations; while next_cursor is set, pass it as cursor for the next page.
To keep a copy in sync, walk the whole list with the cursor and no filters once. After that, pass updated_since set to the start of the previous walk minus a margin of a few minutes, and merge by id.
updated_at moves when the automation itself changes: it is turned on or off (by the user, through the API or by the system), renamed, reordered, or its trigger, steps or condition change. A move to a folder is not a change, nor are new runs or a change of an e-mail of the automation. A deleted automation simply disappears. Repeat the full walk now and then to notice moves and deletions.
Request
- Base URLhttps://api.getsitecontrol.com
- AuthHTTP bearer
Path parameters
Query parameters
true: only automations that are on; false: off
Only automations started by any of these trigger types; repeat for several
Only automations started by a form submit of this widget; widget id from list_widgets
Words of the name in order; case, spacing and punctuation are ignored. Or the exact id
Only automations created at or after this moment; without an offset, taken as UTC; a plain date means its start
Only automations whose updated_at is at or after this moment: changed themselves; a move to a folder and a deletion are not changes; without an offset, taken as UTC; a plain date means its start
Only the items of this folder, an id from list_folders; 0 is General
next_cursor of the previous page, sent with the same order; omit for the first
Items per page
Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field
Order of a list. oldest: the oldest item first; newest: the newest item first, for the latest items without paging through the history.
Order of the items: oldest first (default) or newest first; asc and desc mean the same
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.