---
title: "List Data Flows"
method: GET
path: "/v1/accounts/{account_id}/environments/{environment_id}/rivers"
tags: ["Data Flows", "MCP"]
---

# List Data Flows

`GET /v1/accounts/{account_id}/environments/{environment_id}/rivers`

**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

- `account_id` string, required
- `environment_id` string, required

## Query parameters

- `page` integer — The current page number in the paginated list.
- `items_per_page` integer — The number of items per page in the paginated list.
- `group_name` string, nullable — The river group name
- `group_id` string[], nullable — The river group id
- `name` string, nullable — The river name
- `schedule` 'all' | 'scheduled' | 'unscheduled' — River schedule status enum
- `river_status` RiverStatusEnum[] — The river status
- `interface_type` 'all' | 'new' — River interface type enum. The 'new' represents v2 rivers
- `include_deleted` boolean
- `sort_by` 'last_updated_at' | 'source_name' | 'river_name' | 'group_name' | 'group_id' — The river sort by filter enum provide all the sort by options.
- `sort_order` 'desc' | 'asc' — Sorting can be either asc or desc, used in the api-service
- `river_type` union[], nullable — The river type
  - union
    - 'src_to_trgt' | 'src_to_fz' | 'actions' | 'logic' — All of the INTERNAL river types Customers only familiar with river_type src_to_trgt, actions and logic. Internally we have another river type called src_to_fz.
    - 'source_to_target' | 'actions' | 'logic' | 'connector_executor' — All of the EXTERNAL river types

## Response `200`

Successful Response

- RiverListResponse — List rivers response object.
  - `next_page` string, nullable — The next page URL
  - `previous_page` string, nullable — The previous page URL
  - `page` integer — The page number
  - `current_page_size` integer, required — The current page size
  - `total_items` integer — The total number of entities fetched
  - `account_id` string, required — The account id
  - `environment_id` string, required — The environment id
  - `items` ListRiverObject[], required
    - `name` string, required — Name of the river
    - `river_status` 'active' | 'disabled', required — River status enum. Used in the is_enabled field which is part of the river properties. Disabled status for a river means the river cannot be executed while active status river can.
    - `group_name` string, required — Name of the group associated with the river
    - `group_id` string, required — the id of the group associated with the river
    - `river_schedulers` string[], required — List of schedulers used for the river
    - `datasource_id` string, required — Source ID of the river
    - `last_user_name_modified` string, required — User name of the last modifier
    - `river_cross_id` string, required — River cross ID
    - `last_updated_at` string, date-time, required — Last time the river was modified
    - `description` string, nullable — Description of the river, if available
    - `is_api_v2` boolean, required — Flag indicating whether the river is using API v2
    - `river_type` 'source_to_target' | 'actions' | 'logic' | 'connector_executor', required — All of the EXTERNAL river types
    - `created_at` string, date-time, required — Time the river was created

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/rivery/apis/boomi-data-integration-api.md) · [All operations](https://skmtc.net/rivery/apis/boomi-data-integration-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivery/boomi-data-integration-api/revisions/cd4c91e0e6c2/schema)