REST APIForms API
Get a Form
Retrieve the structure of a specific form, including its fields. This endpoint is used to dynamically build a form on your storefront.
Path Parameters
handlestring
The unique handle of the form.
Response Body
application/json
application/json
curl -X GET "https://yourstore.myshopify.com/a/lantern/form/string"{
"id": "form-id-123",
"handle": "newsletter-signup",
"name": "Newsletter Signup",
"fields": [
{
"handle": "profile:email",
"label": "Email Address",
"required": true,
"valueType": "String",
"fieldType": "Text",
"inputType": "TextInput",
"placeholder": "Enter your email",
"choices": [
{
"id": "string",
"label": "string",
"value": "string",
"selected": true
}
],
"propertyDefinition": {
"metafieldKey": "string"
}
}
]
}{
"error": "Invalid app proxy request"
}