---
title: "Get a Custom Form"
method: POST
path: "/customform.fetch/{typedId}"
tags: ["Custom Forms"]
---

# Get a Custom Form

`POST /customform.fetch/{typedId}`

Retrieves the Custom Form (specified by `typedId`), including all details.

## Response `200`

OK

- object
  - `response` object
    - `node` string
    - `data` object[]
      - `version` number
      - `typedId` string
      - `uniqueName` string
      - `label` string
      - `parentTypedId` unknown
      - `typeId` number
      - `userGroupEdit` unknown
      - `userGroupViewDetails` unknown
      - `module` unknown
      - `results` unknown
      - `inputs` object[]
        - `name` string
        - `label` string
        - `lookupTableId` unknown
        - `url` unknown
        - `type` string
        - `value` number
        - `valueHint` unknown
        - `readOnly` unknown
        - `filter` unknown
        - `parameterGroup` unknown
        - `required` boolean
        - `labelTranslations` unknown
        - `addUnknownValues` unknown
        - `typedId` unknown
        - `alwaysEditable` unknown
        - `inputs` object[]
        - `parameterConfig` object
          - `formatType` string
          - `resultName` string
          - `resultLabel` string
        - `formattingOptions` object
        - `valueOptions` unknown
      - `outputs` object[]
        - `resultName` string
        - `resultLabel` string
        - `result` unknown
        - `excludeFromExport` boolean
        - `warnings` unknown
        - `alertMessage` unknown
        - `alertType` unknown
        - `displayOptions` unknown
        - `formatType` string
        - `suffix` unknown
        - `resultType` unknown
        - `cssProperties` unknown
        - `userGroup` unknown
        - `resultGroup` unknown
        - `overrideValueOptions` unknown
        - `overrideAllowEmpty` boolean
        - `labelTranslations` unknown
        - `overridable` boolean
        - `overridden` boolean
        - `resultDescription` unknown
      - `calculationStatus` number
      - `submitDate` unknown
      - `workflowStatus` string
      - `formStatus` string
      - `submittedByName` unknown
      - `approvedByName` unknown
      - `deniedByName` unknown
      - `createdByName` unknown
      - `lastUpdateByName` unknown
      - `approvalRequiredEmailAttachments` object[]
      - `serverMessagesExtended` unknown
      - `createDate` string
      - `createdBy` number
      - `lastUpdateDate` string
      - `lastUpdateBy` number
      - `attribute1` unknown
      - `attribute2` unknown
      - `attribute3` unknown
      - `attribute4` unknown
      - `attribute5` unknown
      - `attribute6` unknown
      - `attribute7` unknown
      - `attribute8` unknown
      - `attribute9` unknown
      - `attribute10` unknown
      - `attribute11` unknown
      - `attribute12` unknown
      - `attribute13` unknown
      - `attribute14` unknown
      - `attribute15` unknown
      - `attribute16` unknown
      - `attribute17` unknown
      - `attribute18` unknown
      - `attribute19` unknown
      - `attribute20` unknown
      - `attribute21` unknown
      - `attribute22` unknown
      - `attribute23` unknown
      - `attribute24` unknown
      - `attribute25` unknown
      - `attribute26` unknown
      - `attribute27` unknown
      - `attribute28` unknown
      - `attribute29` unknown
      - `attribute30` unknown
      - `customFormTypeObject` object
        - `version` number
        - `typedId` string
        - `uniqueName` string
        - `label` string
        - `headerFormulaName` string
        - `workflowFormulaName` unknown
        - `userGroupEdit` unknown
        - `userGroupViewDetails` unknown
        - `embedded` boolean
        - `supportedParentTypeCodes` object[]
        - `module` string
        - `configuration` object
          - `default` object
            - `icon` string, required
            - `name` string, required
            - `tabs` object, required
              - …
            - `translationKey` string, required
        - `createDate` string
        - `createdBy` number
        - `lastUpdateDate` string
        - `lastUpdateBy` number
    - `status` number

## Other responses

- `400` — Invalid `typedId` specified in the path param.
- `404` — Custom Form with the specified `typedId` was not found.

---

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