---
title: "Get form metadata"
method: GET
path: "/form_metadata_url_path_placeholder"
tags: ["Modal forms"]
---

# Get form metadata

`GET /form_metadata_url_path_placeholder`

## Request

- Base URL: `{siteUrl}`
- URL: `{siteUrl}/form_metadata_url_path_placeholder`
- Auth: none declared

_Note: The path is a placeholder. The actual path is determined by the configuration of the app component._

Get the metadata from the app server to render a form. <br> <br> <a href="https://d3ki9tyy5l5ruj.cloudfront.net/obj/65a45303b5fb79a69a322593627e3b9521c68ba1/ac-form-metadata.png">
  <img src="https://d3ki9tyy5l5ruj.cloudfront.net/obj/65a45303b5fb79a69a322593627e3b9521c68ba1/ac-form-metadata.png" alt="App components form metadata request flow"/>
</a>

## Response `200`

Successfully retrieved the metadata for a single form.

- FormMetadataResponse: Contains the metadata that describes how to display and manage a form.
  - `template` 'form_metadata_v0', required: The interface name and version of a distinct form UI layout. A `template` is directly associated with a particular `metadata` schema.
  - `metadata` object, required: The metadata (i.e., underlying definition) of a form. `metadata` must exist alongside a `template`, and its schema must be specific to the value of that `template`.
    - `title` string, required: The title of the form, which is displayed at the top of the creation form
    - `fields` unknown[], required: An array of form field objects that are rendered in the order they are in the array. Limit of 30 fields. Valid object schemas: [FormField-Checkbox](/reference/modal-forms#formfield-checkbox), [FormField-Date](/reference/modal-forms#formfield-date), [FormField-Datetime](/reference/modal-forms#formfield-datetime), [FormField-Dropdown](/reference/modal-forms#formfield-dropdown), [FormField-MultiLineText](/reference/modal-forms#formfield-multilinetext), [FormField-RadioButton](/reference/modal-forms#formfield-radiobutton), [FormField-RichText](/reference/modal-forms#formfield-richtext), [FormField-SingleLineText](/reference/modal-forms#formfield-singlelinetext), [FormField-StaticText](/reference/modal-forms#formfield-statictext), [FormField-Typeahead](/reference/modal-forms#formfield-typeahead)
      - unknown
    - `on_submit_callback` string: The URL to `POST` the form to when the user clicks the submit button. If this is field is omitted then the submission button will be disabled. This is useful if the user must enter information in a watched field first, such as to show additional fields.
    - `on_change_callback` string: The URL to `POST` the form to whenever watched field values are changed.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Server error

---

[API](https://skmtc.dev/asana/apis/app-components.md) - [All operations](https://skmtc.dev/asana/apis/app-components/llms.txt) - [OpenAPI document](https://skmtc.dev/asana/apis/app-components/revisions/bbebcce5c9f6?raw)
