Skip to main content

Email API

Account Management

MethodEndpointDescription
GET/email/accountsList connected accounts
DELETE/email/accounts/:idDisconnect account
POST/email/connect/imapConnect IMAP/SMTP account
POST/email/test-imapTest IMAP connection
GET/email/connect/gmailGet Gmail OAuth URL
GET/email/connect/microsoftGet Microsoft OAuth URL
POST/email/accounts/:id/syncTrigger manual sync

Email Operations

MethodEndpointDescription
GET/emailList emails (query: accountId, direction, isRead, isStarred, search, page, limit)
GET/email/:idGet email with full body
GET/email/thread/:threadIdGet thread messages
POST/email/sendSend new email
POST/email/:id/replyReply to email
POST/email/:id/forwardForward email
PATCH/email/:id/readMark read/unread
PATCH/email/:id/starToggle star
DELETE/email/:idDelete email
POST/email/bulk/deleteBulk delete
POST/email/bulk/readBulk mark read/unread

Entity Linking

MethodEndpointDescription
POST/email/:id/linkLink email to entity
DELETE/email/:id/linkUnlink email from entity
GET/email/linked/:entityType/:entityIdGet entity's emails

Inbox Rules

MethodEndpointDescription
GET/email/rulesList rules
POST/email/rulesCreate rule
PATCH/email/rules/:idUpdate rule
DELETE/email/rules/:idDelete rule

Providers

ProviderAuthSetup
GmailOAuth 2.0One-click connect
Microsoft 365OAuth 2.0One-click connect
IMAP/SMTPPasswordManual host/port config