/workflowsList Workflows
Returns the paginated list of workflows in the specified project, ordered by authored date descending.
Accessible to all Forge, Studio, and Workspace cohort roles subject to RLS; no PROJECT_AUTHOR role required for read access.
| status | query | Return only workflows with this status. Omit it for every status. |
| limit | query | How many workflows to return, 1 to 100 (a larger number is treated as 100). Default 25. |
| cursor | query |
Omit it for the first page. |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 401 | K9O_INVALID_CREDENTIALS | The request was made without a valid session or bearer token. |
| 401 | K9O_SESSION_EXPIRED | Your session has expired; re-authenticate and retry. |
| 403 | K9O_ACCESS_DENIED | Your role does not include any Forge, Studio, or Workspace cohort permission required to list workflows. |
| data * | object[] | The project's workflows, newest first. When more match, |
| id * | string | The workflow id ( |
| projectId * | string | The project the workflow belongs to ( |
| name * | string | The workflow's name. |
| description * | string | What the workflow does. Empty when none was given. |
| status * | "active" | "archived" | "draft" |
|
| triggerType * | "view_row_event" | "form_submission" | "scheduled" | "manual" | "webhook" | What starts a run. |
| triggerConfig * | object | The trigger's settings, an object. Its shape depends on
The webhook signing secret is never part of it. |
| actions * | object[] | The steps, in order. |
| index * | integer | The step's position in the chain, from 0. |
| action_type * | string | What the step does: |
| config * | any | The step's settings. Their shape depends on
|
| retry | any | The step's retry settings, |
| condition | any | The predicate that decides whether the step runs, when set. |
| parallel | boolean | Whether the step runs alongside adjacent parallel steps, when set. |
| rbacBinding * | any | Free-form access metadata stored with the workflow and returned as sent. Default |
| authoredBy * | string | Who created the workflow ( |
| authoredAt * | string <date-time> | When the workflow was created. |
| updatedBy * | string | Who last changed the workflow ( |
| updatedAt * | string <date-time> | When the workflow last changed. |
| meta * | any |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.studio.workflows.list()Showing example in TypeScript
{
"data": [
{
"id": "string",
"projectId": "string",
"name": "string",
"description": "string",
"status": "active",
"triggerType": "view_row_event",
"actions": [
{
"index": 0,
"action_type": "string",
"parallel": false
}
],
"authoredBy": "string",
"authoredAt": "string",
"updatedBy": "string",
"updatedAt": "string"
}
]
}