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

# List all workflows

`GET /workflows`

Returns a list of active workflows.
The workflows are returned 20 at a time, sorted by name.
You must use the links section to get the next 20 results.

## Query parameters

- `name` string
- `_` string

## Response `200`

- ListWorkflowsResponse
  - `workflows` object[]
    - `id` string, required — The resource's ID.
    - `audit` object, required — Creation and last-modification metadata.
      - `createdDate` string, date-time, required — When the resource was first created. ISO-8601 UTC.
      - `createdBy` object, required — User who created the resource.
        - `id` string, required — The resource's ID.
        - `email` string, required — The user's email address (also their login identifier).
        - `username` string, required — The user's display name (e.g. `Jane Doe`).
      - `updatedDate` string, date-time, required — When the resource was last modified. ISO-8601 UTC.
      - `updatedBy` object, required — User who last modified the resource.
        - `id` string, required — The resource's ID.
        - `email` string, required — The user's email address (also their login identifier).
        - `username` string, required — The user's display name (e.g. `Jane Doe`).
    - `name` string, required — The workflow's name.
    - `description` string — Optional long-form description of the workflow.
    - `links` object[] — Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
      - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
      - `href` string, required — URL of the linked resource.
      - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
      - `type` 'Api' | 'App', required — Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
  - `links` object[] — Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 relation), an `href` URL, and a `type` (`Api` or `App`).
    - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
    - `href` string, required — URL of the linked resource.
    - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
    - `type` 'Api' | 'App', required — Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.

## Other responses

- `default`

---

[API](https://skmtc.net/process/apis/process-street-public-api.md) · [All operations](https://skmtc.net/process/apis/process-street-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/process/process-street-public-api/revisions/6199a9464227/schema)
