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

Documentation

• Authentication - API key usage and validation
• Quickstart - Make your first API call
• Client Integration - Full CRM sync workflow
• Prospect Search Editing - Update ICP configurations
• Jobs & Hiring Activity - Company hiring insights
• WebTech Intel - Technology stack detection
• 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/auth/validate

Available Endpoints

Authentication

• GET /api/v1/auth/validate - Validate API credentials

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

{
  "id": "uuid",
  "name": "Company Name",
  "created_at": "2024-01-15T10:30:00Z"
}

Error Response

{
  "error": "ValidationError",
  "message": "Invalid request",
  "request_id": "req-uuid"
}

Support

Email: support@openprospect.io