OpenProspect External Developer API

Create enrichment and discovery orders, fetch delivered companies and prospects, and manage company blacklists through API-key authenticated endpoints.

First Successful Call

import os

import httpx

api_key = os.environ["OPENPROSPECT_API_KEY"]

response = httpx.get(
    "https://api.openprospect.io/api/v1/auth/validate",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30.0,
)
response.raise_for_status()
print(response.json())

Expected response:

{
  "valid": true,
  "scopes": ["orders:read", "orders:write", "companies:read", "prospects:read"]
}

Start Here

• Quick Start: create an enrichment order and fetch results.
• Authentication: understand API keys and scopes.
• Discovery Quick Start: request new company discovery.
• Interactive API: inspect the public OpenAPI schema.
• Error Handling: handle authentication, validation, and retryable errors.

Public Endpoint Groups

Area	Endpoints
Authentication	GET /api/v1/auth/validate
Orders	POST /api/v1/orders, GET /api/v1/orders, GET /api/v1/orders/{order_id}, GET /api/v1/orders/{order_id}/results
Delivery sync	GET /api/v1/deliveries/{prospect_search_id}/companies
Companies	GET /api/v1/companies, GET /api/v1/companies/{company_id} and company subresources
Prospects	GET /api/v1/prospects, GET /api/v1/prospects/{prospect_id}
Blacklists	POST /api/v1/blacklists, blacklist entry endpoints, and prospect search assignments

Support

Email support@openprospect.io with the request ID, endpoint, timestamp, and error response body.