The Pipeium API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

​
Base URL

All API requests should be made to:

https://api.pipeium.com/v1/

​
Authentication

The Pipeium API uses API keys to authenticate requests. You can view and manage your API keys in the Pipeium Dashboard.

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

​
Rate Limiting

The API has rate limits based on your plan:

  • Free tier: 100 requests/hour
  • Pro tier: 1000 requests/hour
  • Enterprise tier: Custom limits

Rate limit headers are included in all API responses:

  • X-RateLimit-Limit: Total requests allowed per hour
  • X-RateLimit-Remaining: Remaining requests for the current hour
  • X-RateLimit-Reset: Time when the rate limit will reset (Unix timestamp)

​
Error Handling

The Pipeium API uses conventional HTTP response codes to indicate the success or failure of an API request:

  • 2xx: Success
  • 4xx: Client errors
  • 5xx: Server errors

Common error codes:

  • 400: Bad Request - Invalid request body or parameters
  • 401: Unauthorized - No valid API key provided
  • 403: Forbidden - API key doesn’t have permission
  • 404: Not Found - Resource doesn’t exist
  • 429: Too Many Requests - Rate limit exceeded
  • 500: Internal Server Error - Something went wrong on our end

Error response format:

{
  "message": "Detailed error message"
}

​
Webhooks

Pipeium can send webhook notifications when certain events occur. Configure webhooks in the dashboard or when creating resources that support notifications.

Webhook requests will include:

  • X-Pipeium-Signature: HMAC SHA-256 signature of the payload
  • X-Pipeium-Event: Type of event (e.g., enrichment.completed, signal.triggered)

​
Available APIs

  1. Lists API

    • Create and manage prospect lists
    • Import from various sources
    • Export to CRM systems

  2. Enrichment API

    • Enrich leads with verified contact information
    • Triple verification for emails and phone numbers
    • Waterfall enrichment across 15+ data providers

  3. Signals API

    • Track buying intent signals
    • Monitor news, job posts, and more
    • Real-time notifications

  4. Settings API

    • Manage API keys and configurations
    • Configure webhooks
    • Set up integrations

​
Support

Need help? Contact us: