Build with prospiq

Enrich a contact

Returns a verified work email and/or direct dial for a single person. The most common entry point to the prospiq API.

Request body

Example request

curl https://prospiq.net/api/v1/enrich \
  -X POST \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Sarah",
    "last_name": "Chen",
    "company": "Stripe",
    "type": "email"
  }'

Response

{
  "status": "VERIFIED",
  "email": "sarah.chen@stripe.com",
  "job_title": "Head of Growth",
  "company_domain": "stripe.com",
  "confidence": 97,
  "credits_remaining": 1499
}

Response fields

Bulk enrich

Enrich up to 50 contacts (Growth) or 100 contacts (Pro) in a single request. Processed sequentially server-side. Webhook delivery available on completion.

Request body

Example request

curl https://prospiq.net/api/v1/enrich/bulk \
  -X POST \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email",
    "contacts": [
      { "first_name": "Sarah", "last_name": "Chen", "company": "Stripe" },
      { "first_name": "Maya",  "last_name": "Patel", "company": "Linear" },
      { "first_name": "Jordan","last_name": "Park",  "company": "Vercel" }
    ]
  }'

Response

{
  "status": "completed",
  "total": 3,
  "verified": 2,
  "not_found": 1,
  "credits_used": 2,
  "credits_remaining": 1497,
  "results": [
    {
      "first_name": "Sarah",
      "last_name": "Chen",
      "company": "Stripe",
      "status": "VERIFIED",
      "email": "sarah.chen@stripe.com",
      "job_title": "Head of Growth",
      "company_domain": "stripe.com",
      "confidence": 97
    },
    {
      "first_name": "Maya",
      "last_name": "Patel",
      "company": "Linear",
      "status": "VERIFIED",
      "email": "maya@linear.app",
      "job_title": "Software Engineer",
      "company_domain": "linear.app",
      "confidence": 92
    },
    {
      "first_name": "Jordan",
      "last_name": "Park",
      "company": "Vercel",
      "status": "NOT_FOUND",
      "company_domain": "vercel.com"
    }
  ]
}

The batch completes synchronously and the response includes all results. We also fire two webhooks (non-blocking, fire-and-forget) once a batch finishes: bulk.completed to any subscribed endpoints, andcontact.verified per verified contact. See webhooks.

Get credit balance

Returns the current credit balance, plan, and daily usage. Use this to surface remaining credits to your users or branch logic before large bulk requests.

Example request

curl https://prospiq.net/api/v1/credits \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx"

Response

{
  "credits": 1497,
  "plan": "growth",
  "daily_requests_used": 38,
  "daily_limit": 500
}

List lists

Returns all lists in your account, ordered by pinned first, then most recently updated.

Example request

curl https://prospiq.net/api/v1/lists \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx"

Response

{
  "lists": [
    {
      "id": "list_8f2a91",
      "name": "Q2 SaaS targets",
      "description": null,
      "color": "indigo",
      "is_pinned": true,
      "contact_count": 142,
      "created_at": "2026-05-12T09:14:00.000Z",
      "updated_at": "2026-05-13T18:22:11.000Z"
    },
    {
      "id": "list_7b4c02",
      "name": "Hot leads - May",
      "description": "Outreach for the June 23 launch",
      "color": "amber",
      "is_pinned": false,
      "contact_count": 38,
      "created_at": "2026-05-08T11:00:00.000Z",
      "updated_at": "2026-05-13T11:42:00.000Z"
    }
  ]
}

Add contact to list

Adds a previously-enriched contact (identified by its search_id from a prior /v1/enrich response) to a list. Fires the contact.added_to_list webhook on success.

Path parameter

Request body

Example request

curl https://prospiq.net/api/v1/lists/list_8f2a91/contacts \
  -X POST \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "search_id": "srch_a7f3e1b2" }'

Response

{
  "success": true,
  "list_id": "list_8f2a91",
  "search_id": "srch_a7f3e1b2"
}

Returns 409 Conflict if the contact is already in the list, or 404 Not Foundif either the list or the search ID don't belong to your account.

Subscribe to an event

Create a webhook subscription. Each subscription is bound to a single event type and target URL. Duplicate active subscriptions (same event + same URL) return 409 Conflict.

Request body

Example request

curl https://prospiq.net/api/v1/subscribe \
  -X POST \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "contact.verified",
    "target_url": "https://yourapp.com/webhooks/prospiq"
  }'

Response

{
  "id": "sub_3f7a02",
  "event": "contact.verified",
  "target_url": "https://yourapp.com/webhooks/prospiq",
  "secret": "whsec_b7a23c91d4e8...",
  "active": true,
  "created_at": "2026-05-13T18:45:00.000Z"
}

Unsubscribing

Delete a subscription by passing its ID as a query parameter:

curl https://prospiq.net/api/v1/subscribe?id=sub_3f7a02 \
  -X DELETE \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx"

Returns { "success": true }.

List subscriptions

Returns all active webhook subscriptions on the authenticated account, plus the catalogue of available event types.

Example request

curl https://prospiq.net/api/v1/webhooks \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx"

Response

{
  "subscriptions": [
    {
      "id": "sub_3f7a02",
      "event": "contact.verified",
      "target_url": "https://yourapp.com/webhooks/prospiq",
      "active": true,
      "consecutive_failures": 0,
      "last_triggered_at": "2026-05-13T18:30:00.000Z",
      "last_failure_at": null,
      "created_at": "2026-05-13T18:45:00.000Z"
    }
  ],
  "available_events": [
    { "event": "contact.verified", "label": "New verified contact" },
    { "event": "credits.low", "label": "Credits running low (50%)" },
    { "event": "credits.exhausted", "label": "Credits exhausted (0)" },
    { "event": "bulk.completed", "label": "Bulk enrichment job completed" },
    { "event": "contact.added_to_list", "label": "Contact added to a list" }
  ]
}

Test a subscription

Send a sample event to a subscription's URL. Useful for validating signature verification and HTTPS reachability without waiting for a real event.

Request body

Example request

curl https://prospiq.net/api/v1/webhooks/test \
  -X POST \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "subscription_id": "sub_3f7a02" }'

Response

On successful delivery:

{
  "success": true,
  "message": "Test webhook delivered to https://yourapp.com/webhooks/prospiq",
  "status_code": 200
}

The test payload includes the same headers as a real delivery, plus X-ProspIQ-Test: true, and a _test: true field on the body.

Poll stored events

Returns the last 25 events of a given type from the past 24 hours. Useful as a fallback if your webhook receiver was down, or for environments where you cannot expose an inbound URL.

Path parameter

Query parameters

Example request

curl "https://prospiq.net/api/v1/webhooks/poll/contact.verified?since=2026-05-13T12:00:00Z" \
  -H "Authorization: Bearer piq_live_xxxxxxxxxxxx"

Response

{
  "events": [
    {
      "id": "evt_a8f31b",
      "event": "contact.verified",
      "payload": {
        "event": "contact.verified",
        "data": { "email": "sarah.chen@stripe.com", "...": "..." },
        "timestamp": "2026-05-13T18:30:00.000Z"
      },
      "created_at": "2026-05-13T18:30:00.000Z"
    }
  ]
}