---
title: "Search and list Flows"
method: POST
path: "/app/v2/flows/search"
tags: ["flows"]
---

# Search and list Flows

`POST /app/v2/flows/search`

## Query parameters

- `period` string

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'name' | 'status' | 'product_category' | 'product_type' | 'created_at' | 'updated_at'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` FlowFilterFields
    - `id` string
    - `name` string
    - `type` string — Use `id` value of any index in `GET /v1/flow_types`
    - `status` 'active' | 'inactive'
    - `product_type` string — Use `id` value of any index in `GET /v1/product_types`
    - `product_category` string — Use `id` value of any index in `GET /v1/product_categories`
    - `custom_attributes` CustomAttributes
    - `associated_facility_id` string, uuid
    - `associated_equipment_id` string, uuid
    - `upstream_facility_id` string, uuid
    - `upstream_equipment_id` string, uuid
    - `downstream_facility_id` string, uuid
    - `downstream_equipment_id` string, uuid
    - `event.id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `upstream_flows.id` string, uuid
    - `downstream_flows.id` string, uuid

## Response `200`

successful operation

- PagedFlowsListV2
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` object[]
    - `name` string
    - `type` string — Use `id` value of any index in `GET /v1/flow_types`
    - `status` 'active' | 'inactive'
    - `product_category` string — Use `id` value of any index in `GET /v1/product_categories`
    - `product_type` string — Use `id` value of any index in `GET /v1/product_types`
    - `custom_attributes` CustomAttributes
    - `upstream_flows_count` integer
    - `downstream_flows_count` integer
    - `upstream_facility_id` string, uuid
    - `downstream_facility_id` string, uuid
    - `upstream_equipment_id` string, uuid
    - `downstream_equipment_id` string, uuid
    - `id` string, uuid
    - `associated_facility_id` string, uuid
    - `associated_equipment_id` string, uuid
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid
    - `upstream_equipment` EquipmentBasic
      - `custom_attributes` CustomAttributes
      - `effective_date` string
      - `id` string, uuid
      - `latitude` number, nullable — latitude on the Earth
      - `longitude` number, nullable — longitude on the Earth
      - `name` string
      - `type` EquipmentTypeShallow
        - `id` string
        - `name` string
    - `downstream_equipment` EquipmentBasic
      - `custom_attributes` CustomAttributes
      - `effective_date` string
      - `id` string, uuid
      - `latitude` number, nullable — latitude on the Earth
      - `longitude` number, nullable — longitude on the Earth
      - `name` string
      - `type` EquipmentTypeShallow
        - `id` string
        - `name` string
    - `upstream_facility` Facility
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string, uuid
      - `updated_by` string, uuid
      - `custom_attributes` CustomAttributes
      - `latitude` number, nullable — latitude on the Earth
      - `longitude` number, nullable — longitude on the Earth
      - `name` string
      - `status` string — Use `id` value of any index in `GET /v1/facility_statuses`
      - `type` string — Use `id` value of any index in `GET /v1/facility_types`
      - `id` string, uuid
    - `downstream_facility` Facility
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string, uuid
      - `updated_by` string, uuid
      - `custom_attributes` CustomAttributes
      - `latitude` number, nullable — latitude on the Earth
      - `longitude` number, nullable — longitude on the Earth
      - `name` string
      - `status` string — Use `id` value of any index in `GET /v1/facility_statuses`
      - `type` string — Use `id` value of any index in `GET /v1/facility_types`
      - `id` string, uuid
    - `associated_equipment` EquipmentBasic
      - `custom_attributes` CustomAttributes
      - `effective_date` string
      - `id` string, uuid
      - `latitude` number, nullable — latitude on the Earth
      - `longitude` number, nullable — longitude on the Earth
      - `name` string
      - `type` EquipmentTypeShallow
        - `id` string
        - `name` string
    - `associated_facility` Facility
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string, uuid
      - `updated_by` string, uuid
      - `custom_attributes` CustomAttributes
      - `latitude` number, nullable — latitude on the Earth
      - `longitude` number, nullable — longitude on the Earth
      - `name` string
      - `status` string — Use `id` value of any index in `GET /v1/facility_statuses`
      - `type` string — Use `id` value of any index in `GET /v1/facility_types`
      - `id` string, uuid

---

[API](https://skmtc.net/validere/apis/carbonhub-api.md) · [All operations](https://skmtc.net/validere/apis/carbonhub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/validere/carbonhub-api/revisions/053edab62415/schema)