ec90bd653983
latestOpenAPI 3.1.02026-08-1084330443.7 KBList Data Flows
Authorization scope: data flow:list
This endpoint gets a summary of all the data flows in an environment
📖 Instructions for usage
list_data_flows
List data flows by name or status. Do NOT call this speculatively.
Before calling, ask the user what they want to do. You can:
- Run a data flow → ask for the name, then call list_data_flows(name=<name>)
- Check run status → ask which flow and use get_run / list_runs
- Create a new flow → use create_data_flow
- Update a flow → ask for the name, then get it and patch it
Always filter by name when the user mentions a specific flow.
Only list without a filter if the user explicitly asks to see all flows.
Returns items plus pagination metadata (total_items, page, has_next).
📚 Per-source request/response examples: https://bitbucket.org/boomii/data-integration-sources-examples/src/main/
Path parameters
Query parameters
The current page number in the paginated list.
The current page number in the paginated list.
The number of items per page in the paginated list.
The number of items per page in the paginated list.
The river group name
The river group name
The river group id
The river group id
[ "5f5b17b0a10e07a4ff4c33" ]
The river name
The river name
River schedule status enum
The river schedule status
The river status
The river status
[ "active" ]
River interface type enum. The 'new' represents v2 rivers
The rivers interface type
The river sort by filter enum provide all the sort by options.
The river sort by filter
Sorting can be either asc or desc, used in the api-service
The river sort order filter
The river type
Response
Successful Response
Example response
{
"items": [
{
"name": "river_name",
"group_name": "river_group_1",
"group_id": "62e7f4352c13160013dc39be",
"river_schedulers": [
"0 * * * *",
"0 0 1 * *"
],
"datasource_id": "5f7d4270fdca16cac18261",
"last_user_name_modified": "user_name",
"river_cross_id": "5f7d4270fdca16cac18261",
"last_updated_at": "2021-01-01T00:00:00.000Z",
"description": "river_description",
"is_api_v2": true,
"created_at": "2021-01-01T00:00:00.000Z"
}
]
}