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

# Data Flows Search

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

**Authorization scope:** `data flow:list` 
 
 **This endpoint searches for data flows for a specific account_id and environment_id, pagination is supported**

## 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_id` string[], nullable — The river group id
- `schedule` 'all' | 'scheduled' | 'unscheduled' — River schedule status enum
- `river_status` 'active' | 'disabled' | 'suspended' — River status enum for search, includes suspended state. Unlike RiverStatusEnum, this enum includes SUSPENDED which is determined by the presence of suspended.suspension_date field on the river object.
- `interface_type` 'all' | 'new' — River interface type enum. The 'new' represents v2 rivers
- `sort_by` 'river_date_updated' | 'group_name' | 'river_name' — The river search 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
- `search_query` string
- `name` string
- `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

- RiverSearchResponse — 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` RiverSearchItem[], required — The list of rivers.
    - `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 — 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
    - `target_type` string, nullable — Target ID of the river
    - `last_user_name_modified` string — 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
    - `source_task_connection_name` string, nullable — Connection name of the source
    - `match_reason` string, nullable — Search query match - a list of reasons why this river was returned
    - `suspended` object, nullable — Suspension status tracking for chronically failing rivers
  - `items_per_page` integer, required — The number of items per page.
  - `request` unknown, required

## 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/35d66a2b03fd/schema)