Skip to main content
Facebook IntegrationVersion: v3

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

leadFormIdstringrequired

Lead form identifier

Example:507f1f77bcf86cd799439011

Query Parameters

locationIdstringrequired

Location identifier

Example:HChooFuiyPpVYzeJ4HMe
isDraftboolean

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

Example:true

Response

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

oneOf
idstringrequired

Facebook lead form id

Example:1731762131493784
namestringrequired

Form name

Example:Automation Lead Form 2026-07-16 00:22:40
localestringrequired

Form locale, lower-cased by Meta

Example:en_US
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.

Example:Test Lead Form - Headline
isOptimizedForQualityboolean

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

Example:false
privacyPolicyUrlstring

Privacy policy URL, repeated from legalContent.privacyPolicy.url

Example:https://example.com/privacy
thankYouPageobject

Confirmation screen

followUpActionUrlstring

URL the follow-up action opens

Example:https://example.com/
followUpActionTextstring

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

Example:Visit us
legalContentobject

Privacy policy and disclaimer