---
title: "Preview a Custom Form Workflow"
method: POST
path: "/customform.preview"
tags: ["Custom Forms"]
---

# Preview a Custom Form Workflow

`POST /customform.preview`

Retrieves workflow details for the Custom Form where workflowStatus=`DRAFT`.<p>
**Avaialble for the following roles**:
- `SUPPORT` (*Investigate for Support*)
- `CUSTOM_FORM_RO` (*View Custom Form*)

## Request body

- object

## Response `200`

OK

- object
  - `response` object
    - `node` string
    - `data` object[]
      - `layout` string, nullable
      - `workflow` object
        - `workflowStatus` string
        - `isSelectStepOnDeny` string
        - `type` string
        - `steps` object[]
          - `reason` string
          - `reasons` string[]
          - `isUserApprover` string
          - `userGroupNames` unknown[], nullable
            - unknown
          - `type` string
          - `minApprovalsForGroups` unknown[], nullable
            - unknown
          - `isPostStepLogicFailed` boolean, nullable
          - `postStepLogicName` string
          - `id` string
          - `executedByNames` object[]
          - `userLoginNames` string[]
          - `userGroupTypedId` string, nullable
          - `approvalRequiredEmailAttachments` object[]
          - `subSteps` object[]
            - `approver` string
            - `approverLoginName` string
            - `approverTypedId` string
            - `executionStatus` string, nullable
            - `lastExecutedBy` string, nullable
            - `lastExecutedByName` string
            - `approvedCount` integer
            - `minApprovalsNeeded` integer
            - `reason` string
            - `comment` string, nullable
            - `comments` object, nullable
            - `lastExecutionDate` string, date, nullable
          - `executionStatus` string
          - `userTypedIds` string[]
          - `lastAccess` string
          - `minApprovalsNeeded` integer
          - `userName` string
          - `delegatedToTypedIds` object[]
          - `userGroupTypedIds` unknown[], nullable
            - unknown
          - `userTypedId` string
          - `uniqueName` string
          - `denialReasons` object[]
          - `userGroupName` string, nullable
          - `isDenialReasonOptional` string
          - `userNames` string[]
          - `comment` string, nullable
          - `mandatoryComments` object, nullable
        - `approvableTypedId` string
        - `currentStepId` string
        - `submitReason` string, nullable
        - `submitterUserName` string, nullable
        - `denialReasons` object[]
        - `submitterTypedId` string, nullable
        - `isDenialReasonOptional` string
        - `id` string
        - `isAddStepRestrictedToWFAdmin` string
      - `resultType` string
    - `status` integer

---

[API](https://skmtc.net/pricefx/apis/the-pricefx-backend-api.md) · [All operations](https://skmtc.net/pricefx/apis/the-pricefx-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pricefx/the-pricefx-backend-api/versions/0850b5d6be73/schema)