Get lead form by ID

GET 
/ad-publishing/facebook/lead-form/:leadFormId

Retrieve a lead form by id. Pass isDraft=true to read an unpublished local draft instead, in which case leadFormId accepts either the bare id or the draft_-prefixed form the listing endpoint reports. The two branches return different shapes, and neither matches the shape the listing endpoint returns for the same form: the published branch carries the full Meta definition (context card, thank-you page, legal content) but no status, createdTime, or pageId, while the draft branch returns the stored document verbatim under _id.

Request

Version stringrequired

API Version

Available optionsv3

leadFormId stringrequired

Lead form identifier

locationId stringrequired

Location identifier

isDraft boolean

Fetch the unpublished draft of this lead form instead of the published form

application/json

The published form from Meta, or the stored draft when isDraft is set

application/json

Schema

Schema

oneOf
• FacebookLeadFormDetailDTO
• FacebookDraftLeadFormDetailDTO

idstringrequired

Facebook lead form id

namestringrequired

Form name

localestringrequired

Form locale, lower-cased by Meta

questionsobject[]required

Questions on the form

contextCardobject

Intro card shown before the questions. The draft representation calls this greetingCard.

questionPageCustomHeadlinestring

Headline above the questions. The draft representation calls this questionPageHeadline.

isOptimizedForQualityboolean

Whether the form uses the higher-intent flow, which adds a review step. Set when the form was created with type: HIGHER_INTENT.

privacyPolicyUrlstring

Privacy policy URL, repeated from legalContent.privacyPolicy.url

thankYouPageobject

Confirmation screen

followUpActionUrlstring

URL the follow-up action opens

followUpActionTextstring

Label for the follow-up action. Omitted by Meta when unset.

legalContentobject

Privacy policy and disclaimer

Example (auto)

{
  "id": "1731762131493784",
  "name": "Automation Lead Form 2026-07-16 00:22:40",
  "locale": "en_US",
  "questions": [
    {
      "id": "1751700749315902",
      "key": "full_name",
      "label": "What is your name?",
      "type": "CUSTOM",
      "options": [
        {
          "key": "Option 1",
          "value": "Option 1"
        }
      ]
    }
  ],
  "contextCard": {
    "id": "1320904143101881",
    "title": "Test Lead Form",
    "content": [
      "Automation test lead form"
    ],
    "style": "PARAGRAPH_STYLE"
  },
  "questionPageCustomHeadline": "Test Lead Form - Headline",
  "isOptimizedForQuality": false,
  "privacyPolicyUrl": "https://example.com/privacy",
  "thankYouPage": {
    "id": "1778746963315596",
    "title": "Thank You",
    "body": "We will contact you shortly.",
    "buttonText": "View website",
    "buttonType": "VIEW_WEBSITE",
    "websiteUrl": "https://example.com/",
    "enableMessenger": false
  },
  "followUpActionUrl": "https://example.com/",
  "followUpActionText": "Visit us",
  "legalContent": {
    "id": "1975017193204256",
    "privacyPolicy": {
      "url": "https://example.com/privacy",
      "linkText": "We respect your privacy"
    },
    "customDisclaimer": {
      "title": "Terms & Conditions",
      "body": {
        "text": "By submitting..."
      },
      "checkboxes": [
        {
          "id": "851816397792714",
          "key": "terms_and_conditions",
          "text": "I agree to the terms & conditions",
          "isRequired": false,
          "isCheckedByDefault": false
        }
      ]
    }
  }
}