Skip to content

workflows_list

Management

List Workflows

List visual workflows. Terminology: In Scenario, when a user says "apps" (e.g. "list my apps"), they usually mean workflows in "ready" status — use status="ready". Same idea for "my ready apps" or "deployable workflows". Args: - privacy: "public" browses the shared public catalog; "private" (default) and "unlisted" browse the current project, whose results can include any privacy - tags: optional tag names, e.g. ["featured"]; non-empty values without commas - status: optional status filter. Values "draft" and "ready" are server-filtered (the API supports them natively, faster). Any other value (e.g. "running", "archived") falls back to a client-side filter applied to the returned page only — _workflowListStatusFilter metadata flags this case. - limit: results per page (default 20, max 100) - page_token: pagination token from a previous response (nextPaginationToken) - team_id, project_id: required for OAuth callers Returns: { workflows } array plus nextPaginationToken when more pages exist. When a non-server status filter is applied, the response also carries _workflowListStatusFilter. Examples: - "List workflows" -> (no required args beyond context) - "List my apps" / "ready workflows" -> status="ready" - "Find featured public templates" -> privacy="public", tags=["featured"], limit=3; call workflow_get with a returned id for its full definition (older workflows may have a compiled flow without editor_info)
read-onlyidempotentopen-world

Parameters

NameTypeRequiredDescription
privacyenum(public | private | unlisted)—Catalog selection: public browses shared public workflows; private (default) and unlisted browse the current project. Project listings can include workflows of any privacy.
tagsarray—Filter by workflow tags (for example ["featured"]). Each tag must be non-empty and cannot contain commas.
statusstring—Optional status filter: return workflows whose status matches this string. 'draft' and 'ready' are server-filtered (faster); any other value falls back to a client-side filter on the returned page using the workflow's status or workflowStatus field. Scenario users often say "apps" to mean ready workflows — use action="list" with status="ready".
limitnumber20Results per page (1-100).
page_tokenstring—Pagination token (list).
team_idstring—Team ID. Required with project_id for OAuth callers; an API key is scoped by the key.
project_idstring—Project ID. Required with team_id for OAuth callers; an API key is scoped by the key.
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.

Example Request

JSON
{
  "team_id": "team_abc123",
  "project_id": "proj_xyz789"
}

Example Response

JSON
{
  "workflows": [
    {
      "id": "wf_hero_pipeline",
      "name": "Hero Pipeline",
      "status": "ready"
    }
  ]
}

Common Use Cases

  • List all workflows in a project (every status, e.g. draft and ready)
  • When the user says "apps" or only wants deployable workflows, filter by status="ready"