Lead Gen

Get a lead form

Changed on

Shows a lead form in full, including its questions and thank-you page.

Returns the full form, including the thank-you page, so a form can be diffed against what was created. Meta forms are scoped to the Page the accountId manages: a form on any other Page is a 404, never a read.

get/v1/ads/lead-forms/{formId}

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/ads/lead-forms/{formId}
  • Auth: HTTP bearer

Path parameters

formIdstring required

Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).

Query parameters

accountIdstring required

Connected Meta ads, facebook, instagram or linkedin ads account id (selects the platform). A Meta ads connection resolves its Page through the Facebook account linked to the same profile; an Instagram account uses the Page its ads run under (its own linked Page, else the Facebook or business-login Meta ads account on the same profile).

fieldsstring

Meta only. A Graph field selection passed through verbatim to GET /{form-id}, replacing the default projection, so fields Meta adds later are reachable without an API change. Field names, commas and {} expansion only; anything else (Graph field modifiers such as .limit(), or characters that could open another query parameter) is a 400. Ownership of the form is verified before the selection runs, so this cannot reach any Page but the one accountId manages. Unknown field names are rejected by Meta as a 400.

Response

Form metadata. Meta forms follow MetaLeadForm; LinkedIn forms return LinkedIn's own adForm shape.

statusstring

Example response

{
  "status": "success",
  "form": {
    "locale": "en_US",
    "thank_you_page": {
      "button_type": "VIEW_WEBSITE"
    }
  }
}

Changes

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status