API Reference

REST API Documentation

Full REST API for integrating Helio with your systems. Authentication via session cookies or API tokens.

MethodEndpointDescriptionAuth

POST/api/registerCreate new user account🌐

GET/api/projectsList all projects🔒

POST/api/projectsCreate project🔒

GET/api/projects/:idGet project details🔒

PUT/api/projects/:idUpdate project + provider config🔒

DELETE/api/projects/:idDelete project🔒

GET/api/projects/:id/contactsList contacts (paginated, filterable)🔒

POST/api/projects/:id/contactsCreate single contact🔒

POST/api/projects/:id/contacts/importCSV import (multipart or JSON)🔒

POST/api/projects/:id/contacts/validateValidate pending contacts🔒

GET/api/projects/:id/contacts/exportExport contacts CSV🔒

POST/api/projects/:id/contacts/bulkBulk delete/tag/suppress/activate🔒

GET/api/projects/:id/contacts/:cidGet contact detail + history🔒

PUT/api/projects/:id/contacts/:cidUpdate contact🔒

DELETE/api/projects/:id/contacts/:cidDelete contact🔒

GET/api/projects/:id/templatesList templates🔒

POST/api/projects/:id/templatesCreate template🔒

GET/api/projects/:id/templates/:tidGet template🔒

PUT/api/projects/:id/templates/:tidUpdate template🔒

GET/api/projects/:id/templates/:tid/scanSpam content scan🔒

POST/api/projects/:id/templates/:tid/test-sendSend test email🔒

GET/api/projects/:id/campaignsList campaigns🔒

POST/api/projects/:id/campaignsCreate campaign🔒

POST/api/projects/:id/campaigns/:cid/sendSend campaign🔒

GET/api/projects/:id/campaigns/:cid/statsCampaign statistics🔒

GET/api/projects/:id/automationsList automations🔒

POST/api/projects/:id/automationsCreate automation🔒

POST/api/projects/:id/dns/checkCheck DNS records🔒

POST/api/projects/:id/dns/auto-setupCloudflare auto DNS🔒

GET/api/projects/:id/dns/detectDetect DNS provider🔒

GET/api/projects/:id/healthDomain health score🔒

GET/api/projects/:id/provider-statusProvider limits & status🔒

POST/api/projects/:id/test-connectionTest provider connection🔒

GET/api/projects/:id/warmingWarming schedule & logs🔒

POST/api/projects/:id/warming/startStart warming🔒

POST/api/projects/:id/warming/pausePause warming🔒

GET/api/projects/:id/analyticsEngagement analytics🔒

GET/api/projects/:id/statsProject stats (time series)🔒

POST/api/projects/:id/segmentsCount/preview segment🔒

GET/api/projects/:id/tagsList tags🔒

POST/api/projects/:id/tagsCreate tag or assign tags🔒

GET/api/projects/:id/suppressionsSuppression list🔒

GET/api/projects/:id/webhook-logsWebhook event logs🔒

GET/api/teamsList user's teams🔒

POST/api/teamsCreate team🔒

POST/api/teams/:id/switchSwitch active team🔒

POST/api/teams/:id/inviteInvite team member🔒

POST/api/webhooks/sesSES SNS webhook receiver🌐

POST/api/webhooks/mailgunMailgun webhook receiver🌐

GET/api/track/openOpen tracking pixel🌐

GET/api/track/clickClick tracking redirect🌐

POST/api/unsubscribeUnsubscribe contact🌐

Authentication

All authenticated endpoints (🔒) require a valid session. Sign in via POST /api/auth/callback/credentials with email + password.

Rate Limits

API calls are limited by your plan. Free: 1,000 emails/month. Starter: 15,000. Pro: 75,000.