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

# List Flows

`GET /api/v1/flows`

List all process flows associated with your company profile.

## Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

## Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

- latestVersion
- latestVersion_count
- latestVersionExists
- latestVersion.variables
- deployedVersion
- deployedVersion_count
- deployedVersionExists
- deployedVersion.variables
- currentVersion
- currentVersion_count
- currentVersionExists
- currentVersion.latestRun
- currentVersion.steps
- currentVersion.steps.connector
- currentVersion.steps.connector.authenticationImplementation
- currentVersion.steps.connector.authenticationImplementation.system
- currentVersion.steps.variables
- currentVersion.steps.cache
- currentVersion.steps.dataPool
- currentVersion.steps.scriptVersion
- currentVersion.steps.scriptVersion.script
- currentVersion.schedules
- currentVersion.variables
- versions
- versions_count
- versionsExists
- versions.schedules
- versions.variables
- versions.deployedByUser
- labels
- labels_count
- labelsExists
- webhooks
- webhooks_count
- webhooksExists
- callbacks
- callbacks_count
- callbacksExists
- notificationGroups
- notificationGroups_count
- notificationGroupsExists
- messageBrokers
- messageBrokers_count
- messageBrokersExists
- messageBrokerQueues
- messageBrokerQueues_count
- messageBrokerQueuesExists
- deployments
- deployments_count
- deploymentsExists
- deployments.virtualEnvironment
- deployments.flowVersion
- deployments.package
- deployments.enabledBy


## Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

- name
- marketplace_app_id
- labelled
- enabled
- deployed


## Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

- flows.id
- flows.name
- flows.enabled_at


## Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

- name
- enabled_at
- created_at
- id

## Query parameters

- `filter[name]` string
- `filter[marketplace_app_id]` string
- `filter[blueprint_id]` string
- `filter[blueprint_version_number]` string
- `filter[labelled]` string
- `filter[enabled]` string
- `filter[deployed]` string
- `filter[versions.id]` string
- `filter[,]` string
- `filter[versions]` string
- `filter[id]` string
- `include` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- FlowsListResponse
  - `data` Flows[]
    - `id` integer — Unique identifier
    - `name` string
    - `enabled_at` string, date-time
    - `status` 'Draft' | 'Inactive' | 'Deployed'
    - `format` 'csv' | 'json' | 'txt' | 'xml'
    - `body` string
    - `deployed_at` string
    - `labels` string
    - `notification_groups` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `description` string
    - `layout_direction` string
    - `is_enabled` object
    - `latest_version` object
    - `current_version` object
    - `deployed_version` object
    - `latest_deployed_version` object[]
    - `versions` object[]
    - `version_type_counts` object[]
    - `message_brokers` object[]
    - `message_broker_queues` object[]
    - `notification_group_ids` object[]
    - `webhooks` string
    - `callbacks` string
    - `current_version_step_count` integer
    - `current_version_connector_count` integer
    - `current_version_script_count` integer
    - `current_version_cache_count` integer
    - `current_version_data_pool_count` integer
    - `current_version_cross_ref_count` integer
    - `use_queued_time` string
    - `remove_failed_payloads` object[]
    - `priority` object[]
    - `prod_flag` object[]
    - `deployments` object[]
    - `webhooks_count` integer
    - `callbacks_count` integer
    - `marketplace_app_id` integer
    - `blueprint_id` integer
    - `blueprint_version_number` string
    - `flow_folder_id` integer
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)