---
title: "List flows"
method: GET
path: "/v1/flows"
tags: ["flows"]
---

# List flows

`GET /v1/flows`

## Request

- Base URL: `https://api.flowral.app`
- URL: `https://api.flowral.app/v1/flows`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://api.flowral.app/v1/oauth/token`, scopes: `flows:read`)

Flows in the workspace, newest first. Archived flows are excluded unless `archived=true`.

## Query parameters

- `archived` boolean: Return archived flows instead of live ones.
- `q` string: Match on flow name.
- `size` integer: Page size, 1–100.
- `from` integer: Offset.

## Response `200`

SUCCESS

- object
  - `total` integer, required: Total matching, not the length of `items`.
  - `items` FlowSummary[], required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable
    - `archived` boolean, required
    - `public` boolean: Whether this flow is published — readable by anyone with its link, with no account. Assignees, comments and files are never included in the public view.
    - `publicUrl` string, nullable: The published link, or null when the flow is private.
    - `dueDate` string, date-time: The date the flow is meant to land, if one is set.
    - `taskCount` integer
    - `doneCount` integer
    - `readyCount` integer: Tasks that can be started right now.
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `401`: UNAUTHORIZED
- `403`: PLAN_REQUIRED · INSUFFICIENT_SCOPE
- `429`: RATE_LIMITED

---

[API](https://skmtc.dev/flowral/apis/flowral-api.md) · [All operations](https://skmtc.dev/flowral/apis/flowral-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flowral/apis/flowral-api/revisions/6cd2337b682c?raw)