Returns the complete first-paint mail payload in one request: visible mailboxes, the selected mailbox, labels, mailbox counts, workspace revision, and the selected mailbox's first thread page.

get/v1/workspaces/{workspaceId}/mail-page

Request

  • Base URL: https://api.bangermail.com
  • URL: https://api.bangermail.com/v1/workspaces/{workspaceId}/mail-page
  • Auth: HTTP bearer

Query parameters

limitinteger
mailbox_idstring uuid

Preferred mailbox. Falls back to the first visible mailbox.

label_idstring uuid

Return only selected-mailbox threads carrying this label.

view'inbox' | 'sent' | 'drafts' | 'archive' | 'trash' | 'spam' | 'all'

Response

First-paint mail data for the workspace.

Changes

No recorded changes to this operation across all 1 revision of this API.