API Reference Complete REST API documentation for Pipelime.
The Pipelime API follows REST conventions and is documented using the OpenAPI 3.1 specification. All endpoints require authentication via API key or session.
https://app.Pipelime.io/api Include your API key in the Authorization header:
curl -H "Authorization: Bearer ki_your_key_here" \ https://app.Pipelime.io/api/campaigns See Authentication for details on API keys, rate limits, and idempotency.
Method Path Description GET/campaignsList campaigns POST/campaignsCreate a campaign GET/campaigns/{id}Get campaign details PATCH/campaigns/{id}Update a campaign DELETE/campaigns/{id}Delete a campaign POST/campaigns/{id}/startActivate a campaign POST/campaigns/{id}/pausePause a campaign
Method Path Description GET/contactsList contacts POST/contactsCreate a contact GET/contacts/{id}Get contact details PATCH/contacts/{id}Update a contact DELETE/contacts/{id}Delete a contact POST/contacts/importImport contacts from CSV
Method Path Description GET/companiesList companies POST/companiesCreate a company GET/companies/{id}Get company details PATCH/companies/{id}Update a company
Method Path Description GET/email-accountsList email accounts GET/email-accounts/{id}Get account details PATCH/email-accounts/{id}Update account settings DELETE/email-accounts/{id}Disconnect account
Method Path Description GET/blocklistList blocklist entries POST/blocklistAdd to blocklist DELETE/blocklist/{id}Remove from blocklist
Method Path Description GET/webhooksList webhooks POST/webhooksCreate a webhook DELETE/webhooks/{id}Delete a webhook POST/webhooks/{id}/rotate-secretRotate webhook secret
Method Path Description GET/api-keysList API keys POST/api-keysCreate an API key DELETE/api-keys/{id}Revoke an API key
Method Path Description GET/activityList activity events
Method Path Description GET/dashboard/statsGet dashboard statistics
For interactive API documentation with request/response schemas and a playground, visit the API Docs UI .
All errors follow a consistent format:
{ "error" : { "code" : "NOT_FOUND" , "message" : "Campaign not found" } } Code HTTP Status Description UNAUTHORIZED401 Missing or invalid authentication FORBIDDEN403 Insufficient permissions NOT_FOUND404 Resource not found VALIDATION_ERROR422 Invalid request body RATE_LIMITED429 Rate limit exceeded INTERNAL_ERROR500 Server error
