prospects

List prospects (alias of GET /api/v1/prospects).

An alias of GET /api/v1/prospects with identical semantics. New integrations should use GET /api/v1/prospects.

get/mcp/prospects

Request

  • Base URL: https://api.prosp.cc
  • URL: https://api.prosp.cc/mcp/prospects
  • Auth: OAuth 2 (client credentials, token URL https://prosp-mcp-641053169627.auth.eu-central-1.amazoncognito.com/oauth2/token, scopes: mcp/execute)

Query parameters

limitinteger

Maximum number of prospects to return per page (1–200; defaults to 50). A value outside the range is rejected with a 400, not clamped.

offsetinteger

Number of prospects to skip before the page starts, for offset pagination (defaults to 0).

include_deliveredboolean

Include already-acknowledged prospects (default false).

job_idstring

Narrow to a single discovery. Also switches the listing from the de-duplicated customer-wide view to that job's per-discovery rows. Never crosses tenants.

countrystring
Example:SK

Narrow to one or more ISO 3166-1 alpha-2 country codes, case-insensitive (country=sk or country=SK,CZ — comma-separated, no repeated country= keys). Matches the delivered company's country_code. Checked against the real ISO 3166-1 alpha-2 list; an unrecognized code is rejected with 400 invalid_query naming the value, before any other processing. A HARD filter on this read only — it does not change what a discovery targets or delivers, and total always counts the filtered set (never the caller's whole, unfiltered inbox).

Response

Customer-safe prospects.

totalinteger

PAGINATION count — the number of prospects returned in THIS list response. This is a LIST result-set count over your de-duplicated inbox (optionally scoped by job_id), a DIFFERENT concept from a single discovery's delivery count (JobResult.total_prospects / JobStatus.total_prospects) — do not group the two together. Named total to match the sibling search list (ProspectSummaryList.total); note that sibling counts total MATCHES (which can exceed the page), whereas this one counts the rows in this page.

customer_idstring

The authenticated tenant these prospects belong to.

Example response

{
  "prospects": [
    {
      "domain": "acme.de"
    }
  ]
}

Changes

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