List the workspace's automations
const url = 'https://api.pixonaut.app/v1/automations?page=1&pageSize=50&trigger=design.committed';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.pixonaut.app/v1/automations?page=1&pageSize=50&trigger=design.committed' \ --header 'Authorization: Bearer <token>'Operation ID: automations.list
A page of the workspace’s automations by name, each with where it stands and what its firings come to, and how many match in all.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The page to read, from 1; the first when left out.
The page to read, from 1; the first when left out.
Only the automations whose name or trigger holds this text, case aside.
Only the automations whose name or trigger holds this text, case aside.
Only the automations that fire on this event.
Only the automations that fire on this event.
Only the automations that act at this printshop, by its id: a step names it, or a step orders at the blank’s printshop and one of your blanks prints there. Each row then says which of its steps act there.
Only the automations that act at this printshop, by its id: a step names it, or a step orders at the blank’s printshop and one of your blanks prints there. Each row then says which of its steps act there.
Responses
Section titled “Responses”A page of automations
object
object
With printshop: the steps that act at that printshop.
object
named: the step names the printshop. blank: it orders at the blank’s printshop, and a blank prints there.
The member whose grants it acts with: whoever last saved it. Null when it runs as the workspace.
object
The automation’s tree of steps.
object
object
Every one holds.
object
At least one holds.
object
It does not hold.
object
The fact compared.
It holds when the fact is one of these: each at most 200 characters, or 2054 for an origin, which may name a store’s site.
object
It holds from this many copies up.
It holds up to this many copies.
The order’s quantity.
object
The order’s delivery address.
Whether it must be set, or must not.
The steps, in the order they run. A step’s type names an action from the catalogue.
object
Further steps, under each branch’s name.
object
Its id, unique in the body: what a firing names it by.
What its type takes; the draft check refuses settings the type does not.
object
Its action (approve, create_print, place_order, reroute, cancel_order, notify, email, webhook) or flow step (only_if, paths, wait_for, delay).
When it was last enabled: it never fires on an event from before. Null for one never enabled.
object
Spend actions it took in the last 24 hours, against its spend limit.
The sources it acts on: the studio always; designer links, keys and connected stores, each every one or a snapshot. To act on only some, an Only if compares the design’s origin.
object
On, it acts on designs from every secret and publishable key no store was given, those added later too. Off, only from those in keys.
On, it acts on designs from every designer link, those made later too. Off, only from the links in links.
On, it acts on designs from every connected store, those connected later too. Off, only from those in stores. A store may have its own automated flows on its designs; if it does, the first to move one on wins.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
The event it fires on; null for none yet.
When it was last saved: a save names it as expectedUpdatedAt.
Its current version.
How many there are in all.
Examples
Example
{ "automations": [ { "author": { "name": "Ada Lewis", "userId": "u_8b1d2c3e4f5a" }, "body": { "steps": [ { "id": "approve", "settings": {}, "type": "approve" }, { "branches": { "onFailure": [ { "id": "tell", "settings": { "role": "admin" }, "type": "notify" } ] }, "id": "print", "settings": {}, "type": "create_print" } ] }, "createdAt": 1760000000000, "enabled": true, "enabledAt": 1760000500000, "firings": { "count": 42, "lastAt": 1760086400000, "paused": 0, "spentToday": 3, "waiting": 2 }, "id": "aut_3c9e1f7a-2b4d-4e8a-9f6c-1d2e3f4a5b6c", "name": "Hosted link to printshop", "runsAs": "author", "sources": { "includeNewKeys": true, "includeNewLinks": true, "includeNewStores": true, "keys": null, "links": null, "stores": null }, "spendLimit": 50, "standing": { "state": "enabled" }, "trigger": "design.committed", "updatedAt": 1760000400000, "version": 3 } ], "page": 1, "pageSize": 50, "total": 1}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: origin_forbidden, forbidden, feature_disabled
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}forbidden
{ "error": "forbidden"}origin_forbidden
{ "error": "origin_forbidden"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: invalid_query
object
Examples
invalid_query
{ "error": "invalid_query"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].