Skip to main content
GET
/
api
/
v1
/
workflows
List Workflows
curl --request GET \
  --url https://control-plane.kubiya.ai/api/v1/workflows \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "pending",
    "steps": [
      "<unknown>"
    ],
    "current_step": "<string>",
    "configuration": {},
    "team_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "state": {},
    "error_message": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
skip
integer
default:0
​
limit
integer
default:100
​
status_filter
enum<string> | null

Workflow status enumeration

Available options:
pending,
running,
paused,
completed,
failed,
cancelled
​
team_id
string | null

Response

Successful Response

​
id
string
required
​
name
string
required
​
description
string | null
required
​
status
enum<string>
required

Workflow status enumeration

Available options:
pending,
running,
paused,
completed,
failed,
cancelled
​
steps
any[]
required
​
current_step
string | null
required
​
configuration
Configuration · object
required
​
team_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
state
State · object
required
​
error_message
string | null
required