---
title: "List Workflows"
method: GET
path: "/api/v1/workflows/"
tags: ["workflows"]
---

# List Workflows

`GET /api/v1/workflows/`

## Request

- Base URL: `https://platform-api.transform.unstructured.io` (the document declares no server; this is the origin it was published from)
- URL: `https://platform-api.transform.unstructured.io/api/v1/workflows/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/unstructured/apis/platform-api/docs/api/v1/workflows/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of workflows, optionally filtered by source, destination, state, name, date range, and supports pagination and sorting.

## Query parameters

- `dag_node_configuration_id` string, nullable
- `source_id` union
  - string, uuid
  - string
- `destination_id` union
  - string, uuid
  - string
- `status` 'active' | 'inactive'
- `page` integer, nullable
- `page_size` integer, nullable
- `created_since` string, date-time, nullable
- `created_before` string, date-time, nullable
- `name` string, nullable
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `show_only_soft_deleted` boolean, nullable

## Headers

- `unstructured-api-key` string, nullable

## Response `200`

Successful Response

- WorkflowInformation[]
  - `id` string, uuid, required
  - `name` string, required
  - `key` string, nullable
  - `sources` string[], required
  - `destinations` string[], required
  - `workflow_type` 'basic' | 'advanced' | 'platinum' | 'custom'
  - `workflow_nodes` WorkflowNode[], required
    - `id` string, uuid, nullable
    - `name` string, required
    - `type` string, required
    - `subtype` string, required
    - `settings` object, nullable
  - `schedule` WorkflowSchedule
    - `crontab_entries` CronTabEntry[], required
      - `cron_expression` string, required
  - `status` 'active' | 'inactive', required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable
  - `reprocess_all` boolean
  - `skip_preflight` boolean
  - `edit_lock` WorkflowEditLockResponse
    - `locked_by` string, nullable, required: Email of the user editing the workflow, when known.
    - `locked_at` string, date-time, required
    - `expires_at` string, date-time, required
    - `held_by_you` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/unstructured/apis/platform-api.md) - [All operations](https://skmtc.dev/unstructured/apis/platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unstructured/apis/platform-api/revisions/16b4542093db?raw)