---
title: "Get Form"
method: GET
path: "/v3/portals/{portalId}/forms/{formId}"
tags: ["Portal Forms"]
---

# Get Form

`GET /v3/portals/{portalId}/forms/{formId}`

## Request

- Base URL: `https://global.api.konghq.com`
- URL: `https://global.api.konghq.com/v3/portals/{portalId}/forms/{formId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer

Retrieves a single custom form by ID.

## Path parameters

- `portalId` string, uuid, required
- `formId` string, uuid, required

## Response `200`

A custom form belonging to a portal.

- union: A custom form configured for a developer portal, including its fields.
  - object: The form shown in the portal's developer signup flow.
    - `id` string, uuid, required: Contains a unique identifier used for this resource.
    - `created_at` string, date-time, required: An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required: An ISO-8601 timestamp representation of entity update date.
    - `type` 'developer_registration', required
    - `name` string, required: A unique, URL-friendly identifier for the form (lowercase letters, digits, and hyphens). For `developer_registration` forms, this is always `developer-registration`. For `api_registration` forms, you choose the name when creating the form and can change it later.
    - `status` 'published' | 'unpublished', required: Whether the form is visible to developers on the portal. `unpublished` forms aren't shown to developers; for the `developer_registration` form, a default form is shown instead.
    - `fields` CustomFormField[], required: The form's fields, in the order they're displayed. Includes the built-in `full_name` and `email` fields, plus exactly one `submit` field.
      - union: A field on a form, as returned by the API. The `type` property determines what kind of field it is. Fields that came with the form by default carry a `built_in` flag.
        - object: A block of Markdown content, displayed between or above the form's input fields.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'content', required
          - `value` string, required: The Markdown content to display.
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A single-line text field.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'text', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable: Help text displayed with the field. Supports Markdown formatting.
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: An email address field. Rejects values that aren't a valid email format.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'email', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A numeric field.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'number', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A multi-line text field.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'textarea', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A dropdown field where the developer chooses exactly one option. Requires at least 1 option.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'select', required
          - `mode` 'single_select', required: Single selection — the developer chooses exactly one option.
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
          - `options` CustomFormSelectOption[], required: Available choices presented to the developer.
            - `value` string, required: The value submitted when this option is chosen.
            - `label` string, required: The text shown to the developer for this option.
            - `selected` boolean, required: When `true`, this option is pre-selected when the form is displayed. For a single-select field, at most one option may have `selected: true`. Marking more than one option as selected is rejected as invalid.
        - object: A dropdown field where the developer can choose multiple options. Requires at least 2 options.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'select', required
          - `mode` 'multi_select', required: Multiple selection — the developer can choose more than one option.
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
          - `options` CustomFormSelectOption[], required: Available choices presented to the developer.
            - `value` string, required: The value submitted when this option is chosen.
            - `label` string, required: The text shown to the developer for this option.
            - `selected` boolean, required: When `true`, this option is pre-selected when the form is displayed. For a single-select field, at most one option may have `selected: true`. Marking more than one option as selected is rejected as invalid.
        - object: A single checkbox.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'checkbox', required
          - `label` string, required
          - `description` string, nullable: Supports Markdown formatting — useful for linking to terms and conditions.
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: The form's submit button. Every form must include exactly one. Its `name` is always `submit`.
          - `name` 'submit', required
          - `type` 'submit', required
          - `value` string, required: The text displayed on the button.
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
  - object: A form shown to developers when they request access to a specific API.
    - `id` string, uuid, required: Contains a unique identifier used for this resource.
    - `created_at` string, date-time, required: An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required: An ISO-8601 timestamp representation of entity update date.
    - `type` 'api_registration', required
    - `name` string, required: A unique, URL-friendly identifier for the form (lowercase letters, digits, and hyphens). For `developer_registration` forms, this is always `developer-registration`. For `api_registration` forms, you choose the name when creating the form and can change it later.
    - `status` 'published' | 'unpublished', required: Whether the form is visible to developers on the portal. `unpublished` forms aren't shown to developers; for the `developer_registration` form, a default form is shown instead.
    - `fields` CustomFormField[], required: The form's fields, in the order they're displayed. Includes exactly one `submit` field and a field named `api_id` of type `text`.
      - union: A field on a form, as returned by the API. The `type` property determines what kind of field it is. Fields that came with the form by default carry a `built_in` flag.
        - object: A block of Markdown content, displayed between or above the form's input fields.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'content', required
          - `value` string, required: The Markdown content to display.
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A single-line text field.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'text', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable: Help text displayed with the field. Supports Markdown formatting.
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: An email address field. Rejects values that aren't a valid email format.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'email', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A numeric field.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'number', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A multi-line text field.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'textarea', required
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: A dropdown field where the developer chooses exactly one option. Requires at least 1 option.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'select', required
          - `mode` 'single_select', required: Single selection — the developer chooses exactly one option.
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
          - `options` CustomFormSelectOption[], required: Available choices presented to the developer.
            - `value` string, required: The value submitted when this option is chosen.
            - `label` string, required: The text shown to the developer for this option.
            - `selected` boolean, required: When `true`, this option is pre-selected when the form is displayed. For a single-select field, at most one option may have `selected: true`. Marking more than one option as selected is rejected as invalid.
        - object: A dropdown field where the developer can choose multiple options. Requires at least 2 options.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'select', required
          - `mode` 'multi_select', required: Multiple selection — the developer can choose more than one option.
          - `label` string, required
          - `placeholder` string, nullable
          - `description` string, nullable
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
          - `options` CustomFormSelectOption[], required: Available choices presented to the developer.
            - `value` string, required: The value submitted when this option is chosen.
            - `label` string, required: The text shown to the developer for this option.
            - `selected` boolean, required: When `true`, this option is pre-selected when the form is displayed. For a single-select field, at most one option may have `selected: true`. Marking more than one option as selected is rejected as invalid.
        - object: A single checkbox.
          - `name` string, required: A stable, URL-safe slug identifying the field (letters, digits, underscores, or hyphens). When omitted, `label` is slugified instead. Used to match up stored responses across edits.
          - `type` 'checkbox', required
          - `label` string, required
          - `description` string, nullable: Supports Markdown formatting — useful for linking to terms and conditions.
          - `required` boolean, required
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.
        - object: The form's submit button. Every form must include exactly one. Its `name` is always `submit`.
          - `name` 'submit', required
          - `type` 'submit', required
          - `value` string, required: The text displayed on the button.
          - `built_in` boolean, required: Marks a field that comes with the form by default. Built-in fields can't be removed, retyped, or relabeled, but their Built-in fields can't be removed, retyped, or relabeled, and built-in inputs are always `required`. Their `placeholder` and `description` settings can still be changed. This flag is read-only — it's returned by the API but can't be set when creating or updating a form.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-11-20** `757a21fb79f2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/kong/apis/konnect-api/changes/v3/portals/:portalId/forms/:formId/get.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api.md) - [All operations](https://skmtc.dev/kong/apis/konnect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api/revisions/757a21fb79f2?raw)
