List runs

GET

/api/v1/automations/runs

curl --request GET \
  --url https://digize.com/api/v1/automations/runs \
  --header 'x-api-key: <x-api-key>'

• Digize

The newest runs, up to 1,000, of one workflow or all of them.

Needs the automations:read permission.

Authorizations

• apiKey
• bearer

Parameters

Query Parameters

workflowId

string

>= 1 characters <= 64 characters

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

string

workflowId

required

string

workflowName

required

string

mode

required

string

Allowed values: trigger test retry

contact

required

Any of:

object

object

id

required

string

name

required

string

email

required

string

null

null

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

string format: date-time

null

null

resumesAt

required

Any of:

string

string format: date-time

null

null

error

required

string | null

retryOf

required

string | null

total

required

number

Example

{
  "rows": [
    {
      "mode": "trigger",
      "status": "running"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/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.

Media typeapplication/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.

Media typeapplication/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).

Media typeapplication/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.

Media typeapplication/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"
  }
}