v1

latestOpenAPI 3.0.32026-07-26737274.2 KB

Forms

List forms

Returns a cursor-paginated list of forms and landing pages in the account. Both live on this endpoint — filter with type=embed for embedded forms or type=hosted for landing pages. By default only active forms are returned; use status (active, archived, trashed, or all) to widen the search. Add include=subscriber_count to embed each form's subscriber count.

Each form includes its uid, embed_js, and embed_url for embedding on your site. To see who joined via a form, use List subscribers for a form; to add an existing subscriber, use Add subscriber to form.

get/v4/forms

Query parameters

{"stackTrail":"paths:/v4/forms:get:parameters:0:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch next page of results, use ?after=<end_cursor>

{"stackTrail":"paths:/v4/forms:get:parameters:1:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch previous page of results, use ?before=<start_cursor>

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

{"stackTrail":"paths:/v4/forms:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}

Number of results per page. Default 500, maximum 1000.

status'active' | 'archived' | 'trashed' | 'all' nullable

Filter forms that have this status (active, archived, trashed, or all). Defaults to active.

{"stackTrail":"paths:/v4/forms:get:parameters:5:schema","oasType":"schema","type":"unknown","nullable":true}

Filter forms and landing pages by type. Use embed for embedded forms. Use hosted for landing pages.

includestring

Comma-separated list of additional fields to include on each form. Valid options: subscriber_count.

Response

Returns a paginated list of all forms and landing pages (embedded and hosted) for your account (including active and archived)