Public API v1

ProspectB2B Public API documentation

Public, indexable API documentation for developers building lead syncs, outbound sales workflows, CRM imports, webhook automations and operational tooling on ProspectB2B.

Browse referenceOpenAPI JSONCreate API key
Base path
/api/public/v1
Scopes
21 available
Webhook events
9 events
Access model
Read docs publicly

What the API covers

The public API is designed for B2B prospecting and lead-management workflows where an external system needs to read workspace data, create or upsert leads, launch exports, inspect jobs and subscribe to signed webhooks.

  • Create, upsert and list leads for CRM sync, enrichment intake or outbound sales automation.
  • Run imports and exports with request_id correlation plus idempotency for safe retries.
  • Register signed webhook sinks for lead, import, export and campaign events.
  • Inspect jobs, campaign runs, prospector workflows, billing snapshots and support tickets.
Fast links
Quickstart with curl, JavaScript and PythonAuthentication, scopes and read-only behaviorFull REST reference grouped by product domainSigned webhooks, retries and troubleshooting

Quick start snapshot

Reading the docs does not require login. Creating credentials or configuring workspace state does.

curl https://login.prospectb2b.com/api/public/v1/leads \
  -X POST \
  -H "Authorization: Bearer pb2b_live_xxxxx_xxxxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: lead-create-001" \
  -d '{
    "full_name": "Ada Lovelace",
    "email": "[email protected]",
    "company_name": "Analytical Engine Inc."
  }'
Signup gating
CTAs that require a workspace, such as creating keys or configuring webhooks, send users to https://www.login.prospectb2b.com/signup.
  • Start by calling /me to verify the key identity, scopes and read_only state.
  • Use Idempotency-Key for create, import, export, campaign and prospector mutations.
  • Store secrets immediately. API key secrets and webhook signing secrets are shown once.
  • Capture request_id on failures so support and observability can trace the request precisely.

Primary use cases

The documentation is written for developers and technical buyers evaluating whether the ProspectB2B API can support a production integration.

B2B lead generation API

Create or sync prospect records from forms, outbound tooling or enrichment workflows.

CRM lead import API

Batch import records, inspect import errors and keep mappings aligned with lead fields.

Webhook integrations for SaaS

Subscribe to signed events for lead changes, exports, imports and campaign lifecycle events.

REST API for prospecting platform

Inspect jobs, prospector runs, inbox history and workspace-level settings snapshots.

OpenAPI and consistency

The public portal, the in-app authenticated workspace and the backend contract are all aligned to the same generated OpenAPI document.

  • OpenAPI JSON is published at https://www.login.prospectb2b.com/developers/api/openapi.json.
  • Reference operations are grouped by the same domain tags used in the generated spec.
  • Schemas document request_id, rate-limit headers, error envelopes and idempotency expectations.
  • The export download route intentionally documents readiness metadata because the repository does not expose an API-side presigned download URL.
curl https://login.prospectb2b.com/api/public/v1/me \
  -H "Authorization: Bearer pb2b_live_xxxxx_xxxxx"