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

Request

  • Base URL
    https://api.kit.com
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Query parameters

afterunknown

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

beforeunknown

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.

per_pageunknown

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.

typeunknown

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)

Changes

No recorded changes to this operation across all 2 revisions of this API.