API Reference

One REST API for every part of your customer ops.

70+ endpoints. JSON in, JSON out. Bearer-token auth. The same API the InboxOS dashboard uses — no second-class integrations, no scraping, no rate limits to your own data.

Get an API key Quickstart guide

Base URL

https://api.inboxos.space

Auth

Authorization: Bearer <API_KEY>

Content-Type

application/json

Conversations

Inbox

Unified inbox across email, WhatsApp, SMS, social and chat. Each conversation has threaded messages and lifecycle state.

GET/api/v1/conversationsList conversations (filter by status, channel, assignee)
GET/api/v1/conversations/:idGet a single conversation with messages
POST/api/v1/conversationsCreate a new conversation
PATCH/api/v1/conversations/:idUpdate status, assignee, tags
POST/api/v1/conversations/:id/messagesReply to a conversation
POST/api/v1/conversations/:id/closeClose a conversation
POST/api/v1/conversations/:id/reopenReopen a closed conversation

Contacts

CRM

People, leads, and customers with custom fields, tags, and full activity timeline.

GET/api/v1/contactsList contacts with cursor pagination
POST/api/v1/contactsCreate a contact
GET/api/v1/contacts/:idGet contact with timeline
PATCH/api/v1/contacts/:idUpdate fields, tags
DELETE/api/v1/contacts/:idDelete a contact
POST/api/v1/contacts/bulkBulk import via CSV or JSON array
POST/api/v1/contacts/:id/tagsAdd tags

Deals

CRM

Kanban-style pipeline with custom stages, values, and probability. Triggers fire on stage transitions.

GET/api/v1/dealsList deals (filter by stage, owner)
POST/api/v1/dealsCreate a deal
PATCH/api/v1/deals/:idUpdate value, stage, owner
POST/api/v1/deals/:id/moveMove deal to a different stage
GET/api/v1/pipelinesList pipelines and their stages

Tasks

Productivity

Per-contact / per-deal todos with due dates, reminders, and assignees.

GET/api/v1/tasksList tasks (filter by status, assignee, due)
POST/api/v1/tasksCreate a task
PATCH/api/v1/tasks/:idUpdate task
POST/api/v1/tasks/:id/completeMark task complete

Campaigns

Marketing

One-to-many sends with audience segments, schedule, and per-channel throttling.

GET/api/v1/campaignsList campaigns
POST/api/v1/campaignsCreate a campaign (draft)
POST/api/v1/campaigns/:id/scheduleSchedule for send
POST/api/v1/campaigns/:id/sendSend immediately
GET/api/v1/campaigns/:id/statsDelivery + engagement stats

Email

Channel

Transactional and broadcast email via SES. Domains, templates, and event tracking.

POST/api/v1/email/sendSend a single email
POST/api/v1/email/batchSend up to 100 emails in one call
GET/api/v1/email/eventsList delivery/open/click events
GET/api/v1/email/analyticsAggregate stats
GET/api/v1/email/analytics/dailyDaily time-series for charts
POST/api/v1/email/domainsAdd a sending domain (returns DKIM/SPF)
POST/api/v1/email/domains/:id/verifyTrigger DNS verification

Templates

Content

Reusable messages with Handlebars variables — usable across email, WhatsApp, and SMS.

GET/api/v1/templatesList templates
POST/api/v1/templatesCreate template
PATCH/api/v1/templates/:idUpdate template
POST/api/v1/templates/:id/renderServer-side render with variables

Workflows

Automation

Visual flow builder with triggers, branches, delays, and AI nodes.

GET/api/v1/flowsList workflows
POST/api/v1/flowsCreate a workflow
POST/api/v1/flows/:id/publishPublish a draft workflow
POST/api/v1/flows/:id/triggerManually trigger for a contact
GET/api/v1/flows/:id/runsList execution history

Analytics

Insights

Pre-built analytics across messaging, sales, and engagement.

GET/api/v1/analytics/overviewWorkspace-wide top-line metrics
GET/api/v1/analytics/funnelsConversion funnels
GET/api/v1/analytics/cohortsRetention cohorts

API Keys

Admin

Scoped, revocable keys for programmatic access. Each scope can be enabled independently.

GET/api/v1/api-keysList keys (no secrets returned)
POST/api/v1/api-keysCreate a key (returns secret once)
POST/api/v1/api-keys/:id/rotateGenerate a new secret
POST/api/v1/api-keys/:id/revokeImmediately revoke

Billing

Admin

Subscription, usage metering, invoices. Razorpay + Stripe both supported.

GET/api/v1/billing/subscriptionCurrent plan, seats, status
GET/api/v1/billing/invoicesList GST-compliant PDF invoices
GET/api/v1/billing/usagePer-channel usage for the period
POST/api/v1/billing/checkoutStart a plan upgrade checkout

Audit Logs

Admin

Immutable record of every config change, send, and admin action for compliance.

GET/api/v1/admin/audit-logsCursor-paginated audit log
GET/api/v1/admin/audit-logs/exportAsync export to CSV

Webhooks

Register an HTTPS endpoint and InboxOS will POST signed JSON events to it in near-real time. Every payload includes an X-InboxOS-Signature HMAC-SHA256 header you can verify with your webhook secret.

conversation.createdconversation.repliedconversation.closedcontact.createdcontact.updateddeal.stage_changeddeal.wondeal.lostemail.deliveredemail.bouncedemail.openedemail.clickedemail.unsubscribedmessage.sentmessage.failedflow.run.startedflow.run.completedflow.run.failed

Errors

400

bad_request

Validation failed — see the body for which field

401

unauthorized

Missing or invalid API key

403

forbidden

Key lacks the required scope for this resource

404

not_found

Resource does not exist (or not in your workspace)

409

conflict

Idempotency collision or duplicate unique field

429

rate_limited

Slow down. Check the Retry-After header

500

server_error

Our fault — we got paged

503

unavailable

Maintenance or a dependency is down

Start building today

Free tier gives you 1,000 messages and full API access — no credit card required.

Get started Read the docs