Get Form

Get a tracked, published Conversion-native form by id, including the fields of its published definition. Each field's fieldId is the key used to reference the field in the forms JavaScript API and in submission data. DROPDOWN and MULTI_CHECKBOX fields also list their selectable options, so you can map a submitted value back to the option label a visitor saw. A MULTI_CHECKBOX submits the values of every ticked option as a single semicolon-separated string, such as analytics;automation.

Only tracked, published Conversion-native forms resolve; unknown ids, forms belonging to another workspace, external and ad forms, and untracked, archived, or never-published forms all return a form_not_found error.

get/v2/forms/{formId}

Request

Base URL
https://pub-api.conversion.ai/api
Auth
- API key in header X-API-Key
- or API key in query parameter api_key

Path parameters

formIdstring uuid required

The Conversion form id, as returned by GET /v2/forms.

Response

Form retrieved successfully.

Example response

{
  "data": {
    "form": {
      "id": "9f3c1a2e-6b7d-4e2a-9c1f-1a2b3c4d5e6f",
      "name": "Demo Request",
      "submissionCount": 412,
      "fields": [
        {
          "fieldId": "aa8b2c1d-4e5f-4a6b-8c9d-0e1f2a3b4c5d",
          "name": "email",
          "options": [
            {
              "label": "1-10 employees",
              "value": "1-10"
            }
          ]
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.