---
title: "Get a flow"
method: GET
path: "/app/v1/flows/{id}"
tags: ["flows"]
---

# Get a flow

`GET /app/v1/flows/{id}`

## Path parameters

- `id` string, uuid, required

## Query parameters

- `period` string

## Response `200`

A successful operation

- union
  - 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_flow_ids` string[]
    - `downstream_flow_ids` string[]
    - `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_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
    - `downstream_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
  - 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_flow_ids` string[]
    - `downstream_flow_ids` string[]
    - `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_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
    - `downstream_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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_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
  - 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_flow_ids` string[]
    - `downstream_flow_ids` string[]
    - `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_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
    - `downstream_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
    - `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
  - 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_flow_ids` string[]
    - `downstream_flow_ids` string[]
    - `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_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
    - `downstream_flows` Flow[]
      - `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_flow_ids` string[]
      - `downstream_flow_ids` string[]
      - `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
    - `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)