---
title: "Gets a workflow."
method: GET
path: "/api/v1/workflow"
tags: ["Workflow"]
---

# Gets a workflow.

`GET /api/v1/workflow`

## Request

- Base URL: `https://api.approval.studio` (the document declares no server; this is the origin it was published from)
- URL: `https://api.approval.studio/api/v1/workflow`
- Auth: API key in header `Authorization`

## Query parameters

- `WorkflowUID` string

## Response `200`

OK

- GetWorkflowResponseApiResponse
  - `version` string, nullable
  - `statusCode` integer
  - `message` string, nullable
  - `isError` boolean, nullable
  - `responseException` unknown
  - `result` GetWorkflowResponse
    - `workflowUID` string, nullable
    - `name` string, nullable
    - `isActive` boolean
    - `created` string, date-time
    - `actions` WorkflowActionDto[], nullable
      - `uid` string, nullable
      - `friendlyName` string, nullable
      - `triggerType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
      - `reactionType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
      - `userUIDs` string[], nullable
      - `roleUids` string[], nullable
      - `triggerExecutorUid` string, nullable
      - `triggerRoleUid` string, nullable
      - `emailSubject` string, nullable
      - `emailLanguage` string, nullable
      - `password` string, nullable
      - `comment` string, nullable
      - `checklistName` string, nullable
      - `checklistItems` string[], nullable
      - `daysToDueDate` integer, nullable
      - `allowDownload` boolean, nullable
      - `isSimpleMode` boolean, nullable
      - `isCustomPayload` boolean, nullable
      - `webhookURL` string, nullable
      - `webhookRequestType` string, nullable
      - `webhookContentType` string, nullable
      - `webhookHeaders` object[], nullable
      - `webhookFields` string[], nullable
      - `webhookCustomFields` object[], nullable
      - `webhookCustomPayload` string, nullable
      - `contacts` string, nullable
      - `emailTemplateId` integer, nullable
      - `targetKanbanColumnUid` string, nullable
    - `roles` WorkflowRoleDto[], nullable
      - `uid` string, nullable
      - `name` string, nullable
      - `isInternal` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/approval/apis/public-api.md) · [All operations](https://skmtc.dev/approval/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/approval/apis/public-api/revisions/acf217b75f2a?raw)