Skip to main content
GET
List forms

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page
integer

Page number, starting at 1. Defaults to 1.

per_page
integer

Number of forms per page. Defaults to 20.

with_status
enum<string>

Only forms with this status. Blank means every status.

Available options:
draft,
active,
with_form_type
enum<string>

Only forms of this type. general also matches forms saved with no type. Blank means every type.

Available options:
post_purchase,
pre_purchase,
general,
search_query
string

Only forms whose title contains this text, ignoring case and leading or trailing spaces. % and _ match themselves.

sorted_by
enum<string>

Order of the list. Defaults to newest first.

Available options:
created_at_desc,
created_at_asc,
title_asc,
title_desc,

Response

object | null

Success

data
(object | null)[] | null

The forms on this page, newest first.

A form as the admin sees it. Responses also carry public_token, embed_settings, embed_url, and share_url, described under Generate a public token.

pagination
object | null

Where this page sits in the full list.

filters
object | null

The sort options the admin offers for forms.