Skip to main content
list_prospects Read saved campaign opportunities and existing prospects for one website. Views separate active, independently won and closed records. No checks or outreach start.
Name recorded in the 2026-10-27 deployment. This page describes current source; verify inputs and access in your connected catalog. Provider configuration and workspace access still apply.
This operation reads or updates saved campaign records with the contacts capability enabled. It starts no verification, schedule, message or sequence and consumes no checking credits.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

Returned result

Schema-validated example; IDs and dates are illustrative. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

Validation and omitted values

List one website at a time. Active excludes closed records and independently verified wins. Won uses retained present evidence, not a sender report. Closed includes retired, declined and abandoned records. Archived rollback records are omitted from every view. Omit after for the first page. Keep nextAfter opaque and preserve website, view and filters on continuation. Campaign and externalRef filters use exact saved values. contactId also finds ordinary monitored links using that contact. Reading their associations does not create a second record or change monitoring. No checks, provider collection or outreach start.

Defaults when omitted

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.
  • items (array, required): Records in this bounded page.
  • nextAfter (string / null, required).
Types, allowed values, limits and nested fields:
Download input schema · Download output schema

Errors and retries

Follow the error recovery before retrying this read. Preserve the selected workspace, project, filters and feed. Recovering a read does not require an idempotency key or another verification job. Operation-specific errors include UNAUTHORIZED, INSUFFICIENT_SCOPE, CAMPAIGNS_NOT_READY, PROSPECT_ACCESS_DENIED, INVALID_PROSPECT_INPUT, INVALID_CURSOR. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

This operation has no separate resource alias. Use its generic command route in a matching environment.

Continue

get_prospect · save_prospect Follow the related workflow. See capability status for availability or the command index for another operation.