Skip to content

List Forms

GET
/forms

List and search the org’s lead-capture forms.

Use search to find a specific form by name (e.g. “discovery”). Each item carries the source_id and form_key needed for the overview endpoint.

Authorizations

Parameters

Query Parameters

page

1-indexed page.

integer
default: 1 >= 1

1-indexed page.

per_page

Rows per page (max 200).

integer
default: 20 >= 1 <= 200

Rows per page (max 200).

search
Any of:
string
<= 200 characters

Case-insensitive substring match on form name/id.

source_id
Any of:
string
<= 500 characters

Filter to a single write key / site.

sort_field
Any of:
string
Allowed values: submissions_30d total_submissions latest_submitted_at form_tag_id

Total_submissions | latest_submitted_at | form_tag_id

sort_order
Any of:
string
Allowed values: asc desc

Asc | desc

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Paginated envelope for the forms list/search endpoint.

object
items
Array<object>

One lead-capture form as returned by the list/search endpoint.

object
display_name
Any of:
string
form_key
Any of:
string
id
required

The form’s HTML tag id (or the id-less group key).

string
latest_submitted_at
Any of:
string format: date-time
page_url
Any of:
string
source_id
Any of:
string
target_list_id
Any of:
integer
target_list_name
Any of:
string
total_submissions

Total submissions received for this form.

integer
page
integer
default: 1
per_page
integer
default: 20
total
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string