Read Flows

Retrieve a list of flows with pagination support.

Args: current_user (User): The current authenticated user. session (Session): The database session. settings_service (SettingsService): The settings service. components_only (bool, optional): Whether to return only components. Defaults to False.

get_all (bool, optional): Whether to return all flows without pagination. Defaults to True. This field must be True because of backward compatibility with the frontend - Release: 1.0.20

folder_id (UUID, optional): The folder ID. Defaults to None. params (Params): Pagination parameters. remove_example_flows (bool, optional): Whether to remove example flows. Defaults to False. header_flows (bool, optional): Whether to return only specific headers of the flows. Defaults to False.

Returns: list[FlowRead] | Page[FlowRead] | list[FlowHeader] A list of flows or a paginated response containing the list of flows or a list of flow headers.

Query Parameters
remove_example_flows Remove Example Flows
components_only Components Only
get_all Get All
folder_id Folder Id
header_flows Header Flows
page Page Possible values: 1 ≤ value
size Size Possible values: 1 ≤ value ≤ 100

Responses
200 Successful Response Schema — OPTIONAL undefined
422 Validation Error Schema — OPTIONAL detail object[] — OPTIONAL loc undefined[] msg Message type Error Type