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

# List Data Flows

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

## Request

- Base URL: `https://api.rivery.io`
- URL: `https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers`
- Auth: HTTP bearer

**Authorization scope:** `data flow:list` 
 
 **This endpoint gets a summary of all the data flows in an environment**

## 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', nullable: River schedule status enum
- `river_status` RiverStatusEnum[]: The river status
- `interface_type` 'all' | 'new', nullable: 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
- `sort_order` 'desc' | 'asc': The river sort order filter
- `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: Status of the river
    - `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: Type of the river
    - `created_at` string, date-time, required: Time the river was created

## Other responses

- `422`: Validation Error

## Changes

> 765 revisions in range; 2 not diffed.

- **2026-11-09** `75e8c5d8f575`: 1 info
  - api tag `MCP` removed
- **2026-10-24** `00b90942c8d6`: 1 info
  - endpoint added
- **2026-10-24** `0a8241f415c4`: 1 breaking
  - api path removed without deprecation
- **2026-08-06** `ddd6b1c27983`: 3 info
  - api tag `Data Flows` added
  - api tag `MCP` added
  - api tag `Rivers` removed

[Operation history](https://skmtc.dev/rivery/apis/boomi-data-integration-api/changes/v1/accounts/:account_id/environments/:environment_id/rivers/get.md)

---

[API](https://skmtc.dev/rivery/apis/boomi-data-integration-api.md) - [All operations](https://skmtc.dev/rivery/apis/boomi-data-integration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rivery/apis/boomi-data-integration-api/revisions/dba2541ebf94?raw)
