---
title: "Get Workflow Details"
method: GET
path: "/workflow/{workflow_uid}"
---

# Get Workflow Details

`GET /workflow/{workflow_uid}`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/workflow/{workflow_uid}`
- Auth: API key in header `x-api-key`

Returns full workflow details. Pass should_populate=true to resolve condition/action reference values (e.g. category, status, team, user) to populated objects instead of raw uids.

## Path parameters

- `workflow_uid` string, required

## Query parameters

- `should_populate` boolean

## Response `200`

200

- object
  - `type` string
  - `data` object
    - `workflow_name` string
    - `workflow_description` string
    - `workflow_uid` string
    - `trigger_module` string
    - `workflow_access` string
    - `allowed_users` unknown[]
      - unknown
    - `allowed_teams` unknown[]
      - unknown
    - `trigger_event` string
    - `trigger_event_name` string
    - `conditions` unknown[]
      - unknown
    - `actions` object[]
      - `action_type` string
      - `action_module` string
      - `field_type` string
      - `field_value` string
      - `display_name` string
      - `custom_values` object[]
        - `label` string
        - `value` string
        - `_id` string
      - `change_value` string
      - `type_of_operation` object
        - `label` string
        - `value` string
      - `_id` string
    - `created_by` object
      - `user_uid` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `external_login_id` unknown
      - `home_phone_number` string
      - `designation` string
      - `emp_code` string
      - `prefix` unknown
      - `work_phone_number` string
      - `mobile_phone_number` unknown
      - `profile_picture` string
      - `hourly_labor_charge` unknown
      - `is_active` integer
      - `is_deleted` integer
      - `created_at` string
      - `updated_at` string
    - `allow_workflow_to_trigger` boolean
    - `is_active` boolean
    - `is_deleted` boolean
    - `created_at` string
    - `updated_at` string
    - `__v` integer

## Other responses

- `400`: 400
- `500`: 500

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/workflow/:workflow_uid/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)