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

# List workflows

`GET /api/v2/workflows`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/workflows`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/workflows/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of workflows

## Query parameters

- `limit` integer
- `skip` integer
- `filter` string
- `sort` string

## Response `200`

Workflows retrieved successfully

- JumpcloudHttpWorkflowsWorkflowListResponse: Response containing a list of workflows with pagination metadata
  - `totalCount` integer, required: Total number of workflows available
  - `results` JumpcloudHttpWorkflowsWorkflowResponse[], required: List of workflows
    - `id` string: Unique identifier of the workflow
    - `name` string: Name of the workflow
    - `description` string: Description of the workflow
    - `dsl` object: JSON definition of the workflow DSL
    - `status` string: Status of the workflow
    - `trigger_type` string: Type of the workflow trigger. Possible values: jc_events, external, scheduler.
    - `execution_role_id` string, nullable: Role ID used to identify the workflow execution. Currently optional as part of the rollout. (null/omitted for legacy workflows)
    - `last_ran` string, date-time, nullable: Timestamp when the workflow was last executed
    - `created_by` string: Identifier of the user who created the workflow
    - `created_at` string, date-time: Timestamp when the workflow was created
    - `updated_at` string, date-time: Timestamp when the workflow was last updated

## Other responses

- `400`: Bad request - invalid query parameters
- `401`: Unauthorized - authentication required
- `default`: Generic error response

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)
