Skip to main content
GET
/
flows
/
runs
Get flow runs
curl --request GET \
  --url https://api.edges.run/v1/flows/runs \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_error": {
      "label": "<string>",
      "message": "<string>"
    },
    "callback": {
      "url": "<string>"
    },
    "status": "CREATED",
    "workflow": {
      "uid": "<string>",
      "metadata": {
        "account_rotation": true
      }
    },
    "started_at": "<string>",
    "finished_at": "<string>",
    "synced_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]
List all flow runs in your workspace with support for filtering, sorting, and pagination. This endpoint is useful for monitoring flow execution history, finding specific runs, or building dashboards. Use Cases:
  • Monitor all flow runs across your workspace
  • Filter runs by status to find completed, failed, or running flows
  • Track runs by specific users or workspaces
  • Find specific runs by their UID
Examples: 
curl --request GET \
  --url 'https://api.edges.run/v1/flows/runs?status=SUCCEEDED&limit=20&sort=-created_at' \
  --header 'X-API-Key: <your-api-key>'

curl --request GET \
  --url 'https://api.edges.run/v1/flows/runs?uid=550e8400-e29b-41d4-a716-446655440000&uid=660e8400-e29b-41d4-a716-446655440001' \
  --header 'X-API-Key: <your-api-key>'

# First page
curl --request GET \
  --url 'https://api.edges.run/v1/flows/runs?limit=50&offset=0' \
  --header 'X-API-Key: <your-api-key>'

# Second page
curl --request GET \
  --url 'https://api.edges.run/v1/flows/runs?limit=50&offset=50' \
  --header 'X-API-Key: <your-api-key>'

curl --request GET \
  --url 'https://api.edges.run/v1/flows/runs?status=RUNNING&status=QUEUED' \
  --header 'X-API-Key: <your-api-key>'

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
​
uid
string<uuid>[] | null
Minimum array length: 1
​
user_uid
string<uuid>[] | null
Minimum array length: 1
​
flow_preset_uid
string<uuid>[] | 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 flow runs

​
id
integer

Flow Run ID

​
uid
string<uuid>

Flow Run UUID

​
user_uid
string<uuid>

Member/User UUID

​
workspace_uid
string<uuid>

Workspace UUID

​
last_error
object

Last error message

​
callback
object

Callback

​
status
enum<string> | null

Flow Run status

Available options:
CREATED,
INVALID,
QUEUED,
SCHEDULED,
BLOCKED,
STOPPED,
RUNNING,
FAILED,
PARTIAL_SUCCEEDED,
SUCCEEDED
​
workflow
object

Workflow schema

​
started_at
string | null

Started at

​
finished_at
string | null

Finished at

​
synced_at
string | null

Synced at

​
created_at
string

Created at

​
updated_at
string | null

Updated at