Get a run

GET

/api/v1/automations/runs/{id}

const url = 'https://digize.com/api/v1/automations/runs/example';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

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://digize.com/api/v1/automations/runs/example \
  --header 'x-api-key: <x-api-key>'

One run with the workflow as it was then and every node’s items in and out.

Needs the automations:read permission.

Authorizations

apiKey
bearer

Parameters

Path Parameters

required

string

>= 1 characters <= 64 characters

Responses

200

Done

application/json

object

required

string

workflowId

required

string

workflowName

required

string

mode

required

string

Allowed values: trigger test retry

contact

required

Any of:

object
null

object

required

string

name

required

string

email

required

string

cause

required

What started it, such as “Order #1042 paid”.

string

status

required

string

Allowed values: running waiting completed failed cancelled

nodeName

required

The node it’s on, or stopped at.

string | null

nodesRun

required

number

nodeCount

required

number

startedAt

required

string format: date-time

finishedAt

required

Any of:

string
null

string format: date-time

resumesAt

required

Any of:

string
null

string format: date-time

error

required

string | null

retryOf

required

string | null

nodes

required

Array<object>

<= 100 items

object

required

string

>= 1 characters <= 64 characters

type

required

The kind of node, such as trigger.form_submitted or action.send_sms.

string

Allowed values: trigger.form_submitted trigger.order_paid trigger.order_refunded trigger.checkout_expired trigger.booking_created trigger.message_received trigger.schedule trigger.webhook action.send_sms action.send_email flow.wait flow.if flow.switch crm.update_contact crm.add_tag crm.create_opportunity app.http_request app.code app.slack_message app.sheets_row

name

required

Unique in the workflow, so expressions can name it: $(‘Wait a day’).

string

<= 60 characters

position

required

object

required

number

required

number

params

required

The node’s settings, as the catalog defines them.

object

key

additional properties

Any of:

string

disabled

boolean

settings

object

onError

string

Allowed values: stop continue

retries

integer

<= 5

notes

string

<= 2000 characters

edges

required

Array<object>

<= 300 items

object

required

string

>= 1 characters <= 200 characters

source

required

string

>= 1 characters <= 64 characters

sourceHandle

required

Main, or true/false for If, or a path’s id for Switch.

string

>= 1 characters <= 64 characters

target

required

string

>= 1 characters <= 64 characters

results

required

Array<object>

object

nodeId

required

string

status

required

string

Allowed values: success error running waiting

startedAt

required

string format: date-time

finishedAt

required

Any of:

string
null

string format: date-time

input

required

The items the node got.

Array

Any of:

string

output

required

The items it gave.

Array

Any of:

string

branch

required

string | null

error

required

string | null

Example

{
  "mode": "trigger",
  "status": "running",
  "nodes": [
    {
      "type": "trigger.form_submitted",
      "settings": {
        "onError": "stop"
      }
    }
  ],
  "results": [
    {
      "status": "success"
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}