---
title: "Retrieve a workflow"
method: GET
path: "/workflows/{workflow_id}"
tags: ["Workflows"]
---

# Retrieve a workflow

`GET /workflows/{workflow_id}`

Retrieves information about a specific workflow by its ID.

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

## Path parameters

- `workflow_id` string, required

## Headers

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

## Response `200`

OK

- WorkflowDefinition — A workflow.
  - `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.
  - `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.

---

[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)