API reference
One page per endpoint.
Each page has a request example, a response example, the error codes named for that route, and idempotency. Markdown: /docs/reference.md and /docs/reference/onboard.md.
Onboard & keys
- POST /api/v1/onboard
- POST /api/v1/recover
- GET /api/v1/recover/confirm
- GET /api/v1/usernames/check
- POST /api/v1/keys
- GET /api/v1/keys
- GET /api/v1/keys/:id
- PATCH /api/v1/keys/:id
- DELETE /api/v1/keys/:id
- GET /api/v1/oauth/grants
- GET /api/v1/oauth/grants/:client_id
- DELETE /api/v1/oauth/grants/:client_id
- POST /api/v1/inboxes/:id/keys
- GET /api/v1/me
- PATCH /api/v1/me
- GET /api/v1/lifecycle/unsubscribe
- POST /api/v1/lifecycle/unsubscribe
Inboxes
- POST /api/v1/inboxes
- POST /api/v1/inboxes/batch
- GET /api/v1/inboxes?q=support&limit=100
- PATCH /api/v1/inboxes/:id
- DELETE /api/v1/inboxes/:id
- POST /api/v1/inboxes/:id/notify
- GET /api/v1/inboxes/:id/wait
- GET /api/v1/inboxes/:id/wait-for-code
- POST /api/v1/workspaces
- GET /api/v1/workspaces
- GET /api/v1/workspaces/:id
- PATCH /api/v1/workspaces/:id
- DELETE /api/v1/workspaces/:id
- GET /api/v1/workspaces/:id/inboxes
- DELETE /api/v1/workspaces/:id/inboxes/:inboxId
Messages
- POST /api/v1/inboxes/:id/messages
- POST /api/v1/inboxes/:id/messages/:msgId/reply
- POST /api/v1/inboxes/:id/messages/:msgId/reply-all
- POST /api/v1/inboxes/:id/messages/:msgId/forward
- GET /api/v1/inboxes/:id/messages
- GET /api/v1/inboxes/:id/messages/:msgId
- DELETE /api/v1/inboxes/:id/messages/:msgId
- POST /api/v1/inboxes/:id/messages/batch-get
- POST /api/v1/inboxes/:id/messages/batch-update
- PATCH /api/v1/inboxes/:id/messages/:msgId
- POST /api/v1/inboxes/:id/messages/:msgId/read
- GET /api/v1/inboxes/:id/messages/:msgId/raw
- GET /api/v1/inboxes/:id/messages/:msgId/attachments/:attId
- GET /api/v1/inboxes/:id/messages/:msgId/attachments/:attId/text
- POST /api/v1/inboxes/:id/messages/:msgId/release
- POST /api/v1/inboxes/:id/inbound