Skip to main content
GET
/
workflows
List workflows
curl --request GET \
  --url https://api.kapso.ai/platform/v1/workflows \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "draft",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "lock_version": 123,
      "message_debounce_seconds": 123,
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "execution_count": 1,
      "last_executed_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
status
enum<string>

Filter by workflow status (draft, active, or archived)

Available options:
draft,
active,
archived
​
name_contains
string

Case-insensitive substring search on workflow name

​
created_after
string<date-time>

Only return workflows created on or after this timestamp

​
created_before
string<date-time>

Only return workflows created on or before this timestamp

Response

Workflows retrieved successfully

List of workflows for the project

​
data
object[]
required