---
title: "List flows"
method: GET
path: "/flows"
tags: ["flows"]
---

# List flows

`GET /flows`

Returns a paginated list of flows.

## Query parameters

- `teamId` string, required
- `page` number, nullable
- `per_page` number, nullable
- `sort` string
- `operator` 'and' | 'or'
- `from` string
- `to` string
- `type` string
- `siteId` string
- `externalSiteId` string
- `streamId` string

## Response `200`

200

- object
  - `data` object[], required
    - `type` 'INPUT' | 'OUTPUT', required
    - `utilityState` 'RESOURCES' | 'RAW_MATERIALS' | 'INTERMEDIATE_PRODUCTS' | 'FINISHED_PRODUCTS' | 'NEUTRALS' | 'INACTIVE_NEUTRALS' | 'ACTIVE_NEUTRALS' | 'WASTE' | 'PRODUCTION_WASTE' | 'CONSUMPTION_WASTE' | 'MIXED_WASTE', required
    - `hazards` string[], required
    - `terminationStandard` 'RECOVERY' | 'RECOVERY_FUNCTION' | 'RECOVERY_FUNCTION_PRODUCT' | 'RECOVERY_FUNCTION_COMPONENT' | 'RECOVERY_MATERIAL_ENHANCED_LOOP' | 'RECOVERY_MATERIAL_PRESERVED_LOOP' | 'RECOVERY_MATERIAL' | 'RECOVERY_MATERIAL_CLOSED_LOOP' | 'RECOVERY_MATERIAL_OPEN_LOOP' | 'RECOVERY_MATERIAL_LINEAR' | 'RECOVERY_NUTRIENT' | 'RECOVERY_NUTRIENT_ANIMAL_FEED' | 'RECOVERY_NUTRIENT_PLANT_FEED' | 'RECOVERY_ENERGY' | 'RECOVERY_ENERGY_POWER' | 'RECOVERY_ENERGY_VECTOR' | 'RECOVERY_ENERGY_KINETIC' | 'RECOVERY_ENERGY_HEAT' | 'CONTROL' | 'CONTROL_NEUTRALIZATION' | 'CONTROL_NEUTRALIZATION_ECO_IMPACT' | 'CONTROL_NEUTRALIZATION_FREE_RELEASE' | 'CONTROL_NEUTRALIZATION_LIMITED_RELEASE' | 'CONTROL_DISPOSAL' | 'CONTROL_DISPOSAL_ISOLATION' | 'CONTROL_DISPOSAL_CONTAINMENT', nullable, required
    - `id` string, cuid, required
    - `description` string, nullable, required
    - `weight` integer, required
    - `units` integer, nullable, required
    - `productId` string, nullable, required
    - `complexity` number, nullable, required
    - `geoTagId` string, nullable, required
    - `date` string, date-time, nullable, required
    - `siteId` string, nullable, required
    - `externalSiteId` string, nullable, required
    - `streamId` string, nullable, required
    - `teamId` string, required
    - `createdAt` string, date-time, nullable, required
    - `updatedAt` string, date-time, nullable, required
    - `_count` object, required
      - `items` number, required
    - `product` object, nullable
      - `id` string, required
      - `name` string, required
    - `documents` object[], required
      - `id` string, required
      - `name` string, required
      - `type` string, required
      - `url` string, required
    - `stream` object, nullable
      - `id` string, cuid, required
      - `name` string, required
    - `items` object[], required
      - `id` string, cuid, required
      - `materialId` string, required
      - `name` string, required
      - `weight` integer, required
      - `material` object, required
        - `id` string, required
        - `name` string, required
  - `total` number, required
  - `pageCount` number, required

## Changes

> 13 revisions in range; 1 could not be searched.

- **2024-08-13** `59be44a59b16` — 26 warning, 1 info
  - added the new `CONTROL` enum value to the `data/items/terminationStandard` response property for the response status `200`
  - added the new `CONTROL_DISPOSAL` enum value to the `data/items/terminationStandard` response property for the response status `200`
  - added the new `CONTROL_DISPOSAL_CONTAINMENT` enum value to the `data/items/terminationStandard` response property for the response status `200`
  - added the new `CONTROL_DISPOSAL_ISOLATION` enum value to the `data/items/terminationStandard` response property for the response status `200`
  - …23 more
- **2024-08-08** `b779d136d694` — 2 info
  - added the new optional `query` request parameter `externalSiteId`
  - added the required property `data/items/externalSiteId` to the response with the `200` status
- **2024-07-08** `3c1a479465dc` — 1 breaking, 1 info
  - removed the required property `data/items/when` from the response with the `200` status
  - added the required property `data/items/date` to the response with the `200` status
- **2024-07-06** `d6824accae7b` — 2 info
  - added the optional property `data/items/product` to the response with the `200` status
  - added the required property `data/items/items/items/material` to the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/atlaz-org/apis/atlaz-api/changes/flows/get.md)

---

[API](https://skmtc.dev/atlaz-org/apis/atlaz-api.md) · [All operations](https://skmtc.dev/atlaz-org/apis/atlaz-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/atlaz-org/atlaz-api/revisions/cebf21627d29/schema)
