Developer API

API reference

Read inbox addresses, watch for new messages, and permanently delete messages using scoped API keys. Full endpoint reference is coming with Phase 4 of the roadmap.

Auth model

  • · Create keys from your Dashboard. The plaintext secret is shown once at creation.
  • · Keys cannot be regenerated. Revoke and issue a new one instead.
  • · Scopes: inbox:read, inbox:write, message:read, message:delete, domain:read.

Base URL

GET  /v1/inboxes
POST /v1/inboxes
GET  /v1/inboxes/:id/messages       Authorization: Bearer <YOUR_BANSOSMAIL_API_KEY>

Endpoints, request/response schemas, and error codes are placeholder while the surface is finalized.