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

# GET /v1/flows

`GET /v1/flows`

List flows

## Query parameters

- `folderId` string
- `limit` number
- `cursor` string
- `status` union[]
  - union
    - 'ENABLED'
    - 'DISABLED'
- `projectId` string, required
- `name` string

## Response `200`

Default Response

- object
  - `data` object[], required
    - `id` string, required
    - `created` string, required
    - `updated` string, required
    - `projectId` string, required
    - `externalId` string, nullable
    - `folderId` string, nullable
    - `status` union, required
      - 'ENABLED'
      - 'DISABLED'
    - `schedule` object, nullable
      - `type` 'CRON_EXPRESSION', required
      - `cronExpression` string, required
      - `timezone` string, required
      - `failureCount` number
    - `publishedVersionId` string, nullable
    - `version` object, required
      - `id` string, required
      - `created` string, required
      - `updated` string, required
      - `flowId` string, required
      - `displayName` string, required
      - `trigger` union, required
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `nextAction` unknown
          - `type` 'PIECE_TRIGGER', required
          - `settings` object, required
            - `pieceName` string, required
            - `pieceVersion` string, required
            - `pieceType` union, required
              - …
            - `packageType` union, required
              - …
            - `triggerName` string
            - `input` object, required
            - `inputUiInfo` object, required
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `nextAction` unknown
          - `type` 'EMPTY', required
          - `settings` unknown, required
      - `updatedBy` string, nullable
      - `valid` boolean, required
      - `schemaVersion` string, nullable
      - `state` union, required
        - 'LOCKED'
        - 'DRAFT'
  - `next` string, nullable — Cursor to the next page
  - `previous` string, nullable — Cursor to the previous page

## Changes

- **2024-12-31** `3c05b427e5b5` — 1 info
  - added the optional property `data/items/externalId` to the response with the `200` status
- **2024-11-12** `499ae054e9e9` — 2 info
  - added the optional property `data/items/version/schemaVersion` to the response with the `200` status
  - added the optional property `data/items/version/trigger/anyOf[subschema #1]/settings/inputUiInfo/sampleDataFileId` to the response with the `200` status
- **2024-09-13** `225ff954244e` — 1 breaking, 1 info
  - api path removed without deprecation
  - endpoint added
- **2024-09-03** `b95c8c8e8262` — 1 breaking
  - the response property `data/items/version/trigger/anyOf[subschema #1]/settings/triggerName` became optional for the status `200`
- **2024-08-14** `ed47604969c3` — 2 breaking, 2 info
  - `query` request parameter `status` list-of-types was narrowed by removing types `string`
  - for the `query` request parameter `status`, the type/format was changed from ``/`` to `array`/``
  - added the new optional `query` request parameter `name`
  - added the optional property `data/items/schedule/failureCount` to the response with the `200` status

[Full history](https://skmtc.dev/activeboxes/apis/activeboxes-documentation/changes/v1/flows/get.md)

---

[API](https://skmtc.dev/activeboxes/apis/activeboxes-documentation.md) · [All operations](https://skmtc.dev/activeboxes/apis/activeboxes-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/activeboxes/activeboxes-documentation/revisions/12c564515962/schema)