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

# List workflows

`GET /workflows`

Retrieves a list of workflow definitions available in your Zuora tenant.

### User Access Permission
You must be assigned the **Workflow View Access** permission to run this operation.

## Query parameters

- `callout_trigger` boolean
- `interval` string
- `name` string
- `ondemand_trigger` boolean
- `scheduled_trigger` boolean
- `page` integer
- `page_length` integer

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Response `200`

OK

- GetWorkflowsResponse
  - `data` WorkflowDefinitionAndVersions[] — The list of workflows retrieved.
    - `active_version` object — Information of the active version.
      - `description` string — The description of the active version.
      - `id` integer — The unique ID of the active version.
      - `status` string — The status of the active version.
      - `type` 'Workflow::Setup' | 'Workflow::Instance' — The type of the active version. Currently the only valid value is 'Workflow::Setup'.
      - `version` string — The version number of the active version.
    - `calloutTrigger` boolean — Indicates whether the callout trigger is enabled for the retrieved workflow.
    - `createdAt` string, datetime — The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.
    - `description` string — The description of the workflow definition.
    - `id` integer — The unique ID of the workflow definition.
    - `interval` string, nullable — The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.
    - `latest_inactive_verisons` Workflow[] — The list of inactive workflow versions retrieved. Maximum number of versions retrieved is 10.
      - `calloutTrigger` boolean — Indicates whether the callout trigger is enabled for the retrieved workflow.
      - `createdAt` string, datetime — The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.
      - `description` string — The description of the workflow.
      - `id` integer — The unique ID of the workflow.
      - `interval` string, nullable — The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.
      - `name` string — The name of the workflow.
      - `ondemandTrigger` boolean — Indicates whether the ondemand trigger is enabled for the workflow.
      - `scheduledTrigger` boolean — Indicates whether the scheduled trigger is enabled for the workflow.
      - `timezone` string, nullable — The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.
      - `type` 'Workflow::Setup' | 'Workflow::Instance' — The type of the workflow. Currently the only valid value is 'Workflow::Setup'.
      - `updatedAt` string, datetime — The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.
      - `version` string — The version number of the workflow.
    - `name` string — The name of the workflow definition.
    - `ondemandTrigger` boolean — Indicates whether the ondemand trigger is enabled for the workflow.
    - `scheduledTrigger` boolean — Indicates whether the scheduled trigger is enabled for the workflow.
    - `status` string — The status of the workflow definition.
    - `timezone` string, nullable — The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.
    - `updatedAt` string, datetime — The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.
  - `pagination` object — An object containing pagination information for the list of workflows returned by the api
    - `next_page` string — A string containing the URL where the next page of data can be retrieved.
    - `page` integer — An integer denoting the current page number.
    - `page_length` integer — An integer denoting the number of workflows in this response. The maximum value is 50.

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)