Open appvitae.ai

Prospecting API

Prospecting is programmatically available under /v1/prospecting. A restricted API key uses prospecting_read for reads and prospecting_write for mutations; most automations need both. The key owner must have the Prospecting module and the same organization access as in the app.

Search lifecycle

Run searches through the same review-before-spend lifecycle as the product:

  1. POST /v1/prospecting/searches creates a draft from structured criteria.
  2. POST /v1/prospecting/searches/:publicId/sample returns a non-billable preview.
  3. POST /v1/prospecting/searches/:publicId/estimate stores the reviewed cap and enrichment choices.
  4. POST /v1/prospecting/searches/:publicId/approve starts the billable run. It has no request body and cannot exceed the stored estimate.
  5. GET /v1/prospecting/searches/:publicId/results polls materialized results.

Use GET /v1/prospecting/searches to list searches and GET /v1/prospecting/searches/:publicId to inspect status. Draft and previewed searches can be refined with PATCH /v1/prospecting/searches/:publicId.

The exact criteria and response schemas are published in the full API reference. Once results exist, use campaign contact import to create or reuse Contacts and add them to an Outreach campaign in one atomic call.

For asynchronous candidate, application, LinkedIn, and message events, see outbound webhooks.