pipeline

Per-state breakdown of a cross-state selection, before spending anything

Read-only. Resolve a cross-state selection into per-state counts and say which states can actually start right now.

The confirm step for a fan-out that includes paid stages: vendor credits are spent per record, so the operator approves the shape of the spend (CO 41 · FL 28 · VA 9) rather than one lump total. Stamps no batches, launches nothing — a preview must never be a way to trigger a run.

Scope only: which states a selection touches does not depend on what you intend to run on them, so stages is rejected here as an unknown field.

post/api/v1/pipeline/trigger-multi/preview

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/pipeline/trigger-multi/preview
Auth: API key in header X-API-Key

Request body

statesstring[] nullable

Restrict the fan-out to these states. Omit to run every state the selection touches. It narrows, never widens: a state named here that the selection does not touch is simply absent from the result.

limitinteger nullable

PER-STATE cap, not a total — limit=100 across 5 states runs up to 500 records. One shared budget would have to pick which state gets starved; capping each leg is the predictable reading of 'take 100 from each'.

entity_idstring nullable

Comma/space/newline-separated UUIDs or GLIDs that may span states. Grouped by state, one run per state. Mutually exclusive with filters.

filtersobject[] nullable

Filter expression, same shape as POST /api/v1/leads/browse, WITHOUT a state clause — the fan-out supplies each leg's own. Mutually exclusive with entity_id.

include_non_operatingboolean

Only meaningful with filters. Mirrors Browse's own default so the per-state counts match the number on the button the operator pressed — see TriggerRequest.include_non_operating.

include_existingboolean

Only meaningful with filters. See TriggerRequest.include_existing.

include_registrationsboolean

Deprecated alias of include_existing (kept one release so saved requests resolve).

Example request

{
  "states": [
    "CO",
    "FL"
  ],
  "limit": 100,
  "entity_id": "GL-CO-00042, GL-FL-00099",
  "filters": [
    {
      "field": "reachability_tier",
      "op": "eq",
      "value": "On Fire"
    }
  ]
}

Response

Successful Response

total_matchedinteger required

total_will_runinteger required

states_readyinteger required

capacity_notestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.