Skip to main content
GET
/
runs
Get runs
curl --request GET \
  --url https://api.edges.run/v1/runs \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "scheduled_run_name": "<string>",
    "action_id": 123,
    "action_name": "<string>",
    "retry_count": 0,
    "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_error": {
      "label": "<string>",
      "message": "<string>",
      "params": {}
    },
    "parameters": {
      "sync_mode": "full"
    },
    "callback": {
      "url": "<string>"
    },
    "output_count": 0,
    "scheduled_run_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "started_at": "<string>",
    "finished_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.edges.run/llms.txt

Use this file to discover all available pages before exploring further.

uid is used for all the endpoints and Run manipulation.The id is an internal identifier returned to smooth and improve speed and accuracy if you have questions about your runs you will want to submit to the team.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
status
enum<string>[] | null
Minimum array length: 1
Available options:
CREATED,
INVALID,
QUEUED,
SCHEDULED,
BLOCKED,
STOPPED,
RUNNING,
FAILED,
PARTIAL_SUCCEEDED,
SUCCEEDED
​
action_name
string[] | null
Minimum array length: 1
​
execution_mode
enum<string>[] | null
Minimum array length: 1
Available options:
LIVE,
ASYNC
​
uid
string<uuid>[] | null
Minimum array length: 1
​
user_uid
string<uuid>[] | null
Minimum array length: 1
​
flow_run_id
(integer | null)[] | null
Minimum array length: 1
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
sort
string[]

Sort by fields. Prefix with - for descending order. Default is ascending order.

Maximum array length: 10
Maximum string length: 128

Response

Returns the runs

​
id
integer

Run ID

​
uid
string<uuid>

Run UUID

​
name
string | null

User-defined label for the run

Maximum string length: 255
​
scheduled_run_name
string | null

Name of the linked scheduled run, if any

Maximum string length: 255
​
action_id
integer

Action ID

​
action_name
string

Action name

​
retry_count
integer
default:0

Retry count

​
user_uid
string<uuid>

Member/User UUID

​
workspace_uid
string<uuid>

Workspace UUID

​
execution_mode
enum<string> | null

Execution mode

Available options:
LIVE,
ASYNC
​
last_error
object

Last error message

​
parameters
object
​
callback
object

Callback (only for async runs)

​
status
enum<string> | null

Run status

Available options:
CREATED,
INVALID,
QUEUED,
SCHEDULED,
BLOCKED,
STOPPED,
RUNNING,
FAILED,
PARTIAL_SUCCEEDED,
SUCCEEDED
​
output_count
integer | null
default:0

Number of outputs generated by the run

​
scheduled_run_uid
string<uuid> | null

If the run is scheduled, this field indicates the scheduled run UUID.

​
started_at
string | null

Started at

​
finished_at
string | null

Finished at

​
created_at
string

Created at

​
updated_at
string | null

Updated at