Skip to content

API Quick Start: Integrate in 5 Minutes

⚡ 5-minute setup
🔗 Multi-language support
📦 Delivery-focused

Start receiving qualified leads from the OpenProspect Intelligence Engine in under 5 minutes. This guide covers the essential integration flow: Authentication, Webhook Setup, and Lead Retrieval.

Prerequisites

Before you begin, ensure you have:

  1. API Key: You need a valid API key (starts with lnc_live_ or lnc_test_).
  2. Base URL:
    • Development: http://localhost:8000/api/v1
    • Production: https://api.openprospect.io/api/v1

Step 1: Authentication

First, verify your API key works. All API requests must include the Authorization header with your API key.

--8<-- "authentication/api-key-auth.sh"

--8<-- "authentication/api-key-auth.py"

--8<-- "authentication/api-key-auth.js"

--8<-- "authentication/api-key-auth.ts"

--8<-- "authentication/api-key-auth.cs"

Success Check

If you receive a 200 OK response with valid: true, your API key is working correctly.

Step 2: Setup Webhook Delivery (Push)

The most efficient way to receive leads is via Webhooks. Configure a destination where OpenProspect will push new leads as they are discovered.

--8<-- "delivery/setup-webhook.sh"

--8<-- "delivery/setup-webhook.py"

--8<-- "delivery/setup-webhook.js"

--8<-- "delivery/setup-webhook.ts"

--8<-- "delivery/setup-webhook.cs"

Testing Webhooks

Use Webhook.site to generate a temporary URL for testing webhook deliveries without setting up a server.

Step 3: Fetch Delivered Leads (Pull)

Alternatively (or additionally), you can fetch leads via the API. This is useful for:

  • Backfilling data
  • Recovering from missed webhooks
  • Periodic synchronization
--8<-- "delivery/fetch-delivered-leads.sh"

--8<-- "delivery/fetch-delivered-leads.py"

--8<-- "delivery/fetch-delivered-leads.js"

--8<-- "delivery/fetch-delivered-leads.ts"

--8<-- "delivery/fetch-delivered-leads.cs"

Next Steps

Now that you're integrated, explore these resources:

📚

Delivery Integration Guide

Deep dive into the delivery system architecture and best practices.

Read Guide →
🔍

API Reference

Explore all available endpoints in the interactive API explorer.

API Reference →
🚨

Error Handling

Learn how to handle rate limits and errors gracefully.

Error Reference →