Flows

Read 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.

get/api/v1/flows/

Query parameters

remove_example_flowsboolean
components_onlyboolean
get_allboolean
folder_idstring uuid nullable
header_flowsboolean
pageinteger
sizeinteger

Response

Successful Response

OR
OR

Changes