API Reference¶

OpenProspect External Developer API documentation.

Interactive API Explorer¶

Explore and test the API endpoints:

Interactive API Reference - Swagger UI with all available endpoints

Getting Started¶

Authentication - API key creation, scopes, and security
Enrichment Quick Start - Submit your first enrichment order in 5 minutes
Enrichment Order Guide - Full enrichment workflow: create orders, track status, retrieve results
Discovery Quick Start - Create a blacklist and discovery order in 5 minutes
Discovery Order Guide - ICP-based company discovery with blacklist integration
Blacklist Management - Create and manage company exclusion lists

Integration Guides¶

Client Integration - CRM sync for discovered leads
Delivery Integration - Webhook and pull-based delivery
Prospect Search Editing - Update ICP configurations
Jobs & Hiring Activity - Company hiring insights
WebTech Intel - Technology stack detection

Reference¶

Python Examples - Working code examples
Error Handling - Error codes and troubleshooting

Base URL¶

https://api.openprospect.io/api/v1/

Authentication¶

All requests require an API key in the Authorization header:

curl -H "Authorization: Bearer lnc_live_YOUR_API_KEY" \
     https://api.openprospect.io/api/v1/orders

Available Endpoints¶

Orders (Enrichment & Discovery)¶

POST /api/v1/orders - Create enrichment or discovery order
GET /api/v1/orders - List your orders
GET /api/v1/orders/{id} - Get order status
GET /api/v1/orders/{id}/results - Get enriched results (companies with contacts)

Blacklists¶

POST /api/v1/blacklists - Create a blacklist
GET /api/v1/blacklists - List your blacklists
GET /api/v1/blacklists/{id} - Get a blacklist
PATCH /api/v1/blacklists/{id} - Update blacklist name/description
DELETE /api/v1/blacklists/{id} - Delete a blacklist
POST /api/v1/blacklists/{id}/entries - Add entries in bulk
GET /api/v1/blacklists/{id}/entries - List entries (paginated)
DELETE /api/v1/blacklists/{id}/entries - Remove entries by ID
GET /api/v1/prospect-searches/{id}/blacklists - List assigned blacklists
PUT /api/v1/prospect-searches/{id}/blacklists - Set assigned blacklists

Prospect Searches¶

GET /api/v1/prospect-searches - List available prospect searches
GET /api/v1/prospect-searches/{id} - Get prospect search details
PATCH /api/v1/prospect-searches/{id} - Update prospect search (ICP)

Companies¶

GET /api/v1/companies - List companies for a prospect search
GET /api/v1/companies/{id} - Get company details
GET /api/v1/companies/{id}/jobs - Get company job listings
GET /api/v1/companies/{id}/webtech-intel - Get company technology stack

Prospects¶

GET /api/v1/prospects - List prospects
GET /api/v1/prospects/{id} - Get prospect details

Deliveries¶

GET /api/v1/deliveries/{id}/companies - Get delivered companies for CRM sync

Response Format¶

All responses are JSON with UTF-8 encoding. Dates use ISO 8601 format.

Success Response¶

{
  "order_id": "4f767705-03a2-4e91-a3e8-1ec3f9dea865",
  "order_type": "ENRICHMENT",
  "status": "RECEIVED",
  "company_count": 5,
  "estimated_cost": null,
  "message": "Order received. Awaiting admin review."
}

Error Response¶

{
  "code": "ORDER_NOT_FOUND",
  "message": "Order with identifier ... not found",
  "resource_type": "Order",
  "identifier": "..."
}

Support¶

Email: support@openprospect.io