Skip to content
Pixonaut

Read an automation

GET
/v1/automations/{id}
curl --request GET \
  --url https://api.pixonaut.app/v1/automations/example \
  --header 'Authorization: Bearer <token>'

Operation ID: automations.get

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

The automation

Media typeapplication/json
object
author
required

The member whose grants it acts with: whoever last saved it. Null when it runs as the workspace.

object
name
required
string | null
userId
required
string
body
required

The automation’s tree of steps.

object
conditions
Any of:
object
all
required

Every one holds.

Array
>= 1 items
steps
required

The steps, in the order they run. A step’s type names an action from the catalogue.

Array<object>
object
branches

Further steps, under each branch’s name.

object
key
additional properties
Array
id
required

Its id, unique in the body: what a firing names it by.

string
>= 1 characters <= 64 characters
settings

What its type takes; the draft check refuses settings the type does not.

object
key
additional properties
type
required

Its action (approve, create_print, place_order, reroute, cancel_order, notify, email, webhook) or flow step (only_if, paths, wait_for, delay).

string
>= 1 characters <= 64 characters
createdAt
required
number
enabled
required
boolean
enabledAt
required

When it was last enabled: it never fires on an event from before. Null for one never enabled.

number | null
firings
required
object
count
required
number
lastAt
required
number | null
paused
required
number
spentToday
required

Spend actions it took in the last 24 hours, against its spend limit.

number
waiting
required
number
id
required
string
name
required
string
runsAs
required
string
sources
required

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
includeNewKeys
required

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.

boolean
includeNewLinks
required

On, it acts on designs from every designer link, those made later too. Off, only from the links in links.

boolean
includeNewStores
required

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.

boolean
keys
required

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
sources
required

Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.

Array<string>
<= 10000 items
takenAt
required

When its switch was turned off: the snapshot is as of then.

integer
links
required

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
sources
required

Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.

Array<string>
<= 10000 items
takenAt
required

When its switch was turned off: the snapshot is as of then.

integer
stores
required

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
sources
required

Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.

Array<string>
<= 10000 items
takenAt
required

When its switch was turned off: the snapshot is as of then.

integer
spendLimit
required
number
standing
required
One of:
object
state
required
string
trigger
required

The event it fires on; null for none yet.

string | null
updatedAt
required

When it was last saved: a save names it as expectedUpdatedAt.

number
version
required

Its current version.

number

Examples

Exampleexample

Example

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

Headers

Section titled “Headers”
X-Request-Id
required
string

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.

401

Section titled “401”

Refused: unauthorized

Media typeapplication/json
object
error
required
string

Examples

Exampleunauthorized

unauthorized

{
  "error": "unauthorized"
}

Headers

Section titled “Headers”
X-Request-Id
required
string

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.

403

Section titled “403”

Refused: origin_forbidden, forbidden, feature_disabled

Media typeapplication/json
object
error
required
string
feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

Headers

Section titled “Headers”
X-Request-Id
required
string

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.

404

Section titled “404”

Refused: automation_not_found

Media typeapplication/json
object
error
required
string

Examples

Exampleautomation_not_found

automation_not_found

{
  "error": "automation_not_found"
}

Headers

Section titled “Headers”
X-Request-Id
required
string

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.

500

Section titled “500”

Refused: db_error. A request that failed unexpectedly answers as text instead.

object
error
required
string

Examples

Exampledb_error

db_error

{
  "error": "db_error"
}

Headers

Section titled “Headers”
X-Request-Id
required
string

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].

Status · Terms of service · Privacy policy · Subprocessors