Coming Soon

API Reference

We're working on comprehensive API documentation. In the meantime, explore our tRPC endpoints in the source code.

API Documentation In Progress

We're building a comprehensive REST API alongside our existing tRPC implementation. The API will provide programmatic access to all PostOrbit features including contacts, flows, campaigns, and analytics.

Planned Endpoints

GET/api/contactsList all contacts with pagination and filtering

POST/api/contactsCreate a new contact or bulk import

GET/api/flowsList all email flows/campaigns

POST/api/flows/:id/executeTrigger a flow execution

GET/api/analyticsRetrieve campaign analytics and metrics

POST/api/webhooksConfigure webhook endpoints

Current Options

tRPC Endpoints

PostOrbit uses tRPC for type-safe API calls. Explore the router definitions in the source code for available procedures.

View tRPC Routers →

Webhooks

Receive real-time notifications for email events like opens, clicks, bounces, and unsubscribes via webhook endpoints.

Learn About Webhooks →

Get Notified When API Docs Launch

Join our Discord community to be the first to know when the full API documentation is available.

Join Discord Watch on GitHub