Getting Started
Authentication
How to authenticate with the Pipelime API.
Authentication
Pipelime supports two authentication methods:
API Keys (recommended for programmatic access)
Create API keys in Settings → API Keys. Two scopes available:
| Scope | Access |
|---|---|
full-access | Read + write on all resources |
read-only | GET endpoints only |
Include the key in the Authorization header:
curl -H "Authorization: Bearer ki_your_key_here" \
https://app.Pipelime.io/api/campaignsRate Limits
- API Keys: 100 requests/minute per key
- Session Auth: 200 requests/minute per user
Rate limit headers are included in every response:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1711720800Idempotency
All write endpoints support the Idempotency-Key header to prevent
duplicate operations:
curl -X POST https://app.Pipelime.io/api/contacts \
-H "Authorization: Bearer ki_your_key" \
-H "Idempotency-Key: unique-request-id-123" \
-d '{"email": "john@example.com"}'Repeated requests with the same key return the cached response.
Session Auth (browser/dashboard)
Session authentication is used automatically when accessing the dashboard. No additional configuration needed.
