List Workflows

List workflows in a workspace with folder and deployment filters, search, sorting, and opaque cursor pagination. A workspace whose folder tree exceeds 10,000 folders is a 413, because the response needs the whole tree to render folder paths.

GET/api/v2/workflows

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one from the Sim dashboard under Settings > API Keys. A workspace API key is not accepted everywhere: operations that act on behalf of a specific human — administrative reads, secret access, and irreversible or governance-affecting writes — always reject it, whatever role the key carries. Each such operation says so in its own description, and the rejection surfaces as 403 unless the operation conceals unauthorized resources, in which case it is reported as 404. Use a personal API key for those.

In: header

Query Parameters

workspaceId*string

Workspace whose workflows should be listed.

Length1 <= length
folderPath?string

Restrict results to workflows in this folder path.

deployedOnly?boolean

Return only workflows with an active deployment when true.

limit?number

Maximum workflows to return per page.

Default50
Range1 <= value <= 100
cursor?string

Opaque pagination cursor returned by a previous request.

search?string

Case-insensitive substring search on the resource name.

Length1 <= length <= 200
sortBy?string

Field used to sort the result.

Default"position"
Value in"position" | "name" | "createdAt" | "updatedAt" | "runCount"
sortOrder?string

Sort direction.

Default"asc"
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/workflows?workspaceId=string"
{
  "data": [
    {
      "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
      "name": "Customer support triage",
      "description": "Routes incoming support requests to the right team.",
      "folderPath": "/Operations",
      "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
      "isDeployed": true,
      "deployedAt": "2026-06-12T10:30:00.000Z",
      "runCount": 42,
      "lastRunAt": "2026-08-09T18:04:11.000Z",
      "createdAt": "2026-05-01T09:00:00.000Z",
      "updatedAt": "2026-08-09T18:04:11.000Z"
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
TypeScriptPOSTCreate Workflow