---
title: "Inline Summary"
method: POST
path: "/api/v1/leads/summary"
tags: ["lists", "lists"]
---

# Inline Summary

`POST /api/v1/leads/summary`

## Request

- Base URL: `https://app.goodleads.club` (the document declares no server; this is the origin it was published from)
- URL: `https://app.goodleads.club/api/v1/leads/summary`
- Auth: API key in header `X-API-Key`

The same summary for an inline shape — one call per chip edit before a
list is ever saved (save happens after checkout, never before).

## Request body

- SummaryRequest
  - `states` string[]
  - `filters` object[]
  - `include_held` boolean
  - `include_existing` boolean: Widen past the Just-started default to existing businesses with a new filing (Browse's checkbox).
  - `lane` string, nullable: all | best | contact
  - `cap` object, nullable: {"type": "count"|"budget", "value": int}
  - `offer_code` string, nullable
  - `channel` string, nullable: phone | email — the one channel this buyer runs
  - `group_by` string[]: Up to two fields to cross-tab the count by (e.g. ["property_classification", "naics_2_digit"]); adds a `groups` block with the four counts per group. Groupable fields are listed in the 422 for an unknown one.

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/goodleads/apis/formation-gtm-api.md) · [All operations](https://skmtc.dev/goodleads/apis/formation-gtm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goodleads/apis/formation-gtm-api/revisions/2068d13a82cf?raw)