List lead forms

Lists the instant lead forms that exist on the Page pageId, as { id, name }. Values are live reads from the ad platform.

GET

/v1/brands/{brandId}/ad-accounts/{accountId}/lead-forms

Authorization

bearerAuth

headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

accountId*string

The ad account id (act_… on Meta, biz_… on Whop).

Query Parameters

pageId*string

Page id that owns the lead forms (from assets.facebookPage.id or getAvailableOptions).

Length1 <= length

cursor?string

Opaque cursor from the previous page's nextCursor. Omit for the first page.

limit?integer

Page size.

Range1 <= value <= 100

Default50

Response Body

List lead forms

application/json

response

leadForms*array<>

nextCursor*|

Pass as cursor to read the next page. Null when there is no next page.

curl -X GET "https://example.com/v1/brands/0/ad-accounts/string/lead-forms?pageId=string" \  -H "Authorization: Bearer koast_sk_..."

{  "leadForms": [    {      "id": "string",      "name": "string"    }  ],  "nextCursor": "string"}

Required scope: read. CLI: koast list-lead-forms, see Ad Accounts commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.