Skip to main content
Facebook IntegrationVersion: v3

Get page lead forms

GET/ad-publishing/facebook/page/{pageId}/forms

Retrieve lead gen forms for a specific Facebook page (published + drafts), sorted newest-first by createdTime. By default each form is returned in full (including its questions) as a plain array; pass projection (comma-separated) to return only the requested fields — any value outside the known field set is rejected. Pass limit (max 100) for a { forms, paging } envelope; use after (from paging.next) to fetch the next batch.

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

pageIdstringrequired

Facebook page identifier

Example:103456789012345

Query Parameters

locationIdstringrequired

Location identifier

Example:loc_abc123
projectionstring[]

Fields to return on each lead form, comma-separated (e.g. ?projection=name,id,pageId,status,isDraft,createdTime). When set, only the requested fields are returned; any other value is rejected. Omit to receive the full form (including questions) as-is.

Available optionsidnamepageIdstatusisDraftcreatedTimelocalepagequestions
Example:["name","id","pageId","status","isDraft","createdTime"]
limitstring

Page size for a paginated fetch (max 100). When set, the response is a { forms, paging } envelope instead of a plain array.

Example:25
afterstring

Opaque cursor for the next batch, taken from the previous response paging.next

Example:25

Response

application/json

A plain array of lead forms (default), or a { forms, paging } envelope when limit is provided. Each entry is either a form published to Facebook or an unpublished local draft — the two shapes differ, and isDraft tells them apart. Supplying projection narrows every entry to the requested fields only.

oneOf
  • Array items
    • oneOf
    idstring

    Facebook lead form id

    Example:925225066711682
    namestring

    Form name

    Example:Automation Lead Form 2026-08-19 00:32:49
    localestring

    Form locale, lower-cased by Facebook. Note drafts report the same locale upper-cased.

    Example:en_US
    statusstring

    Form status. Always ACTIVE in this list — the upstream query filters the others out.

    Example:ACTIVE
    createdTimestring

    Creation time in the Facebook timestamp format (+0000 offset, no sub-second precision). Drafts use ISO-8601 with milliseconds instead, so a client parsing this field must accept both.

    Example:2026-08-19T00:32:57+0000
    pageobject

    Page the form belongs to

    pageIdstring

    Page id, repeated from page.id

    Example:196684453527082
    questionsobject[]

    Questions on the form