List lead forms
List the instant lead forms that already exist on a Page, so you can attach one to a lead-generation ad set.
Tool name: list-lead-forms.
List the instant lead forms that already exist on a Page, so you can attach one to a lead-generation ad set. Pass the Page id (pageId), read it from the ad set's assets.facebookPage.id via getSettings, or from getAvailableOptions. Returns { id, name } per form. Use this BEFORE attachLeadForm whenever a lead-form campaign needs a form and the user hasn't given an exact id, never tell the user to go create one on the ad platform without first listing what they already have.
When to use
Discover a Page's existing lead forms before attaching one to a lead-gen ad set. Read-only. Pair with attachLeadForm. Always list before claiming the user must create a form on the ad platform.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | Yes |
Input
| Field | Type | Required | Description |
|---|---|---|---|
pageId | string | Yes | Page id that owns the lead forms (from assets.facebookPage.id or getAvailableOptions). |
cursor | string | No | Opaque cursor from the previous page's nextCursor. Omit for the first page. |
limit | integer | No | Rows per page, 1-100. Defaults to 50 when paging. Minimum 1, maximum 100. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
leadForms | object[] | Yes | |
nextCursor | string | null | Yes | Pass as cursor to read the next page. Null when there is no next page. |
REST equivalent
GET /v1/brands/{brandId}/ad-accounts/{accountId}/lead-forms, List lead forms. CLI: koast list-lead-forms.