---
title: "Read Flows"
method: GET
path: "/api/v1/flows/"
tags: ["Flows"]
---

# Read Flows

`GET /api/v1/flows/`

Retrieve a list of flows with pagination support.<br><br>Args:<br>    current_user (User): The current authenticated user.<br>    session (Session): The database session.<br>    settings_service (SettingsService): The settings service.<br>    components_only (bool, optional): Whether to return only components. Defaults to False.<br><br>    get_all (bool, optional): Whether to return all flows without pagination. Defaults to True.<br>    **This field must be True because of backward compatibility with the frontend - Release: 1.0.20**<br><br>    folder_id (UUID, optional): The project ID. Defaults to None.<br>    params (Params): Pagination parameters.<br>    remove_example_flows (bool, optional): Whether to remove example flows. Defaults to False.<br>    header_flows (bool, optional): Whether to return only specific headers of the flows. Defaults to False.<br><br>Returns:<br>    list[FlowRead] | Page[FlowRead] | list[FlowHeader]<br>    A list of flows or a paginated response containing the list of flows or a list of flow headers.

## Query parameters

- `remove_example_flows` boolean
- `components_only` boolean
- `get_all` boolean
- `folder_id` string, uuid, nullable
- `header_flows` boolean
- `page` integer
- `size` integer

## Response `200`

Successful Response

- union
  - FlowRead[]
    - `name` string, required
    - `description` string, nullable
    - `icon` string, nullable
    - `icon_bg_color` string, nullable
    - `gradient` string, nullable
    - `data` object, nullable
    - `is_component` boolean, nullable
    - `updated_at` string, date-time, nullable
    - `webhook` boolean, nullable — Can be used on the webhook endpoint
    - `endpoint_name` string, nullable
    - `tags` string[], nullable — The tags of the flow
    - `locked` boolean, nullable
    - `mcp_enabled` boolean, nullable — Can be exposed in the MCP server
    - `action_name` string, nullable — The name of the action associated with the flow
    - `action_description` string, nullable — The description of the action associated with the flow
    - `access_type` 'PRIVATE' | 'PUBLIC'
    - `id` string, uuid, required
    - `user_id` string, uuid, nullable, required
    - `folder_id` string, uuid, nullable, required
  - PageFlowReadOutput
    - `items` FlowRead[], required
      - `name` string, required
      - `description` string, nullable
      - `icon` string, nullable
      - `icon_bg_color` string, nullable
      - `gradient` string, nullable
      - `data` object, nullable
      - `is_component` boolean, nullable
      - `updated_at` string, date-time, nullable
      - `webhook` boolean, nullable — Can be used on the webhook endpoint
      - `endpoint_name` string, nullable
      - `tags` string[], nullable — The tags of the flow
      - `locked` boolean, nullable
      - `mcp_enabled` boolean, nullable — Can be exposed in the MCP server
      - `action_name` string, nullable — The name of the action associated with the flow
      - `action_description` string, nullable — The description of the action associated with the flow
      - `access_type` 'PRIVATE' | 'PUBLIC'
      - `id` string, uuid, required
      - `user_id` string, uuid, nullable, required
      - `folder_id` string, uuid, nullable, required
    - `total` integer, required
    - `page` integer, required
    - `size` integer, required
    - `pages` integer, required
  - FlowHeader[]
    - `id` string, uuid, required — Unique identifier for the flow
    - `name` string, required — The name of the flow
    - `folder_id` string, uuid, nullable — The ID of the folder containing the flow. None if not associated with a folder
    - `is_component` boolean, nullable — Flag indicating whether the flow is a component
    - `endpoint_name` string, nullable — The name of the endpoint associated with this flow
    - `description` string, nullable — A description of the flow
    - `data` object, nullable — The data of the component, if is_component is True
    - `access_type` 'PRIVATE' | 'PUBLIC'
    - `tags` string[], nullable — The tags of the flow
    - `mcp_enabled` boolean, nullable — Flag indicating whether the flow is exposed in the MCP server
    - `action_name` string, nullable — The name of the action associated with the flow
    - `action_description` string, nullable — The description of the action associated with the flow

## Other responses

- `422` — Validation Error

## Changes

- **2025-10-16** `9bd3e81318d7` — 2 warning, 4 info
  - removed the optional property `detail/items/ctx` from the response with the `422` status
  - removed the optional property `detail/items/input` from the response with the `422` status
  - the endpoint scheme security `OAuth2PasswordBearer` was added to the API
  - the endpoint scheme security `OAuth2PasswordBearerCookie` was removed from the API
  - …2 more

[Change history](https://skmtc.dev/langflow-ai/apis/langflow/changes/api/v1/flows/get.md)

---

[API](https://skmtc.dev/langflow-ai/apis/langflow.md) · [All operations](https://skmtc.dev/langflow-ai/apis/langflow/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/langflow-ai/langflow/revisions/9bd3e81318d7/schema)