Get Form Overview

GET

/forms/{form_key}/overview

• Production
• QA

Per-form operational detail: health, submission metrics, destination.

source_id is required and comes from a list_forms result — a form id is only unique within its source.

Authorizations

• BearerAuth

Parameters

Path Parameters

form_key

required

The form’s HTML tag id / group key (from list_forms).

string

The form’s HTML tag id / group key (from list_forms).

Query Parameters

source_id

required

Write key / site the form belongs to (from list_forms).

string

Write key / site the form belongs to (from list_forms).

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

Per-form operational detail (health, metrics, destination).

Mirrors the scalar fields of the in-app GET /forms/{form_key}/overview response. The config-oriented route / permissions blocks from the internal payload are intentionally omitted — an agent describing a form does not need route-editing internals.

object

activation_health

Any of:

string

string

null

null

capture_health

Any of:

string

string

null

null

delivery_health

Any of:

string

string

null

null

delivery_source

Any of:

string

string

null

null

delivery_warning

Any of:

string

string

null

null

destination

Any of:

object

object

key

additional properties

any

null

null

display_name

Any of:

string

string

null

null

form_key

required

string

identity_state

Any of:

string

string

null

null

last_destination_verified_at

Any of:

string

string format: date-time

null

null

last_processed_at

Any of:

string

string format: date-time

null

null

metrics

object

key

additional properties

any

owner_id

Any of:

string

string

null

null

placement_count

integer

recommended_action

Any of:

string

string

null

null

setup_hints

What is missing for someone to own this form’s leads: [{code, message}], e.g. owner_missing.

Array<object>

object

key

additional properties

any

source_id

required

string

technical_form_id

Any of:

string

string

null

null

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string