API Reference

Welcome to the Pipeium API reference documentation. These APIs allow you to programmatically access and manage your Pipeium data.

Authentication

All API endpoints require authentication using an API key. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY

Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of requests:
  • 2xx: Success
  • 4xx: Client errors
  • 5xx: Server errors
Common error responses:
{
  "message": "Unauthorized"  // 401 error
}
{
  "message": "Internal server error"  // 500 error
}

Available Resources

Lists

Enrichments