---
title: "Retrieve an active form for embedding."
method: GET
path: "/form-builder/{formId}/embedding"
tags: ["Forms"]
---

# Retrieve an active form for embedding.

`GET /form-builder/{formId}/embedding`

## Request

- Base URL: `https://api.maildroppa.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maildroppa.com/form-builder/{formId}/embedding`
- Auth: API key in header `X-API-Key`

Returns the active form type and subscriber fields required by a trusted website integration.

## Path parameters

- `formId` string, uuid, required

## Response `200`

Active form embedding retrieved.

- FormEmbedding: Active signup form definition used by trusted website integrations to render subscriber fields.
  - `id` string, uuid
  - `type` 'DEFAULT' | 'SLIDER' | 'INLINE' | 'POPUP' | 'PAGE'
  - `inputFields` FormField[]: Subscriber fields in display order.
    - `fieldRef` union: Strict typed field reference. BUILT_IN references use builtInField only; CUSTOM references use fieldId only.
      - object: Built-in subscriber field reference. Only type and builtInField are valid properties.
        - `builtInField` 'EMAIL' | 'FIRST_NAME'
      - object: Customer-created subscriber field reference. Only type and fieldId are valid properties.
        - `fieldId` string, uuid
    - `personalizationTagName` string: Stable subscriber personalization tag name selected from the field schema.
    - `label` string: Label shown on the form.
    - `placeholder` string: Placeholder text shown on the form.
    - `isRequired` boolean: Whether the form requires this field.
    - `position` integer: Ordering position within the form.
    - `fieldType` 'TEXT' | 'LONG_TEXT' | 'EMAIL' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'SINGLE_CHOICE' | 'MULTI_CHOICE'
    - `inputControl` 'TEXT_INPUT' | 'TEXTAREA' | 'EMAIL_INPUT' | 'NUMBER_INPUT' | 'DATE_INPUT' | 'CHECKBOX' | 'SELECT' | 'RADIO_GROUP' | 'CHECKBOX_GROUP' | 'SELECT_MULTIPLE'
    - `optionValues` string[], required: Choice option labels resolved from the field schema for SINGLE_CHOICE and MULTI_CHOICE rendering.

## Other responses

- `401`: Not Authorized
- `403`: Not Allowed
- `404`: Active form not found.
- `428`: Accept the customer agreements in the app before using API keys.

---

[API](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta.md) · [All operations](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta/llms.txt) · [OpenAPI document](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta/revisions/a9f5a3fd1fb0?raw)