---
title: "Get Form Overview"
method: GET
path: "/forms/{form_key}/overview"
tags: ["Forms"]
---

# Get Form Overview

`GET /forms/{form_key}/overview`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/forms/{form_key}/overview`
- Auth: HTTP bearer

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.

## Path parameters

- `form_key` string, required: The form's HTML tag id / group key (from list_forms).

## Query parameters

- `source_id` string, required: Write key / site the form belongs to (from list_forms).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseFormOverview
  - `data` FormOverview, 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.
    - `form_key` string, required
    - `source_id` string, required
    - `technical_form_id` string, nullable
    - `display_name` string, nullable
    - `owner_id` string, nullable
    - `identity_state` string, nullable
    - `placement_count` integer
    - `capture_health` string, nullable
    - `delivery_health` string, nullable
    - `activation_health` string, nullable
    - `metrics` object
    - `last_destination_verified_at` string, date-time, nullable
    - `recommended_action` string, nullable
    - `last_processed_at` string, date-time, nullable: When a submission of this form was last processed for delivery.
    - `delivery_source` string, nullable: Where leads go: 'route' (tracked delivery route), 'legacy_mapping' (older list mapping; delivered, but processed/failed stay 0 because it writes no receipts) or null (nowhere).
    - `destination` object, nullable: The destination list: {list_id, route_version, source, list_name?}; null when none.
    - `delivery_warning` string, nullable: Plain-language delivery problem, e.g. captured leads with no destination.
    - `setup_hints` object[]: What is missing for someone to own this form's leads: [{code, message}], e.g. owner_missing.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)