---
title: "GET /v1/workspaces/{workspaceId}/mail-page"
method: GET
path: "/v1/workspaces/{workspaceId}/mail-page"
---

# GET /v1/workspaces/{workspaceId}/mail-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

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.

## Query parameters

- `limit` integer
- `mailbox_id` string, uuid
- `label_id` string, uuid
- `view` 'inbox' | 'sent' | 'drafts' | 'archive' | 'trash' | 'spam' | 'all'

## Response `200`

First-paint mail data for the workspace.

- MailPageResponse
  - `data` MailPage, required
    - `mailboxes` Mailbox[], required
      - `id` string, uuid, required
      - `workspace_id` string, uuid, required
      - `product_id` string, uuid, nullable: The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.
      - `domain_id` string, uuid, nullable
      - `address` string, required: The email address, or for an SMS inbox its phone number in E.164 (+15551234567).
      - `display_name` string, required
      - `provider` 'gmail' | 'smtp' | 'twilio', required
      - `channel` 'email' | 'sms' | 'whatsapp': email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.
      - `sms_verification` object, nullable: A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.
        - `status` 'pending_review' | 'in_review' | 'approved' | 'rejected'
        - `reason` string, nullable: Carriers' reason when rejected.
      - `status` 'pending' | 'active' | 'suspended' | 'reconnect_required' | 'disabled', required
      - `status_reason` string, nullable
      - `suspended_at` string, nullable
      - `mailbox_kind` 'domain' | 'starter', required
    - `domains` SendingDomainSummary[], required
      - `id` string, uuid, required
      - `product_id` string, uuid, required
      - `name` string, required
      - `status` 'pending' | 'verified' | 'failed' | 'disabled' | 'deleting' | 'deleted', required
    - `selected_mailbox_id` string, uuid
    - `labels` Label[], required
      - `id` string, uuid, required
      - `mailbox_id` string, uuid, required
      - `name` string, required
      - `color` string, nullable
      - `kind` string, required
      - `updated_at` string, date-time, required
    - `threads` ThreadSummary[], required
      - `id` string, uuid, required
      - `mailbox_id` string, uuid, required
      - `subject` string, required
      - `snippet` string, required
      - `last_message_at` string, date-time, required
      - `message_count` integer, required
      - `unread_count` integer, required
      - `is_archived` boolean, required
      - `is_trash` boolean, required
      - `is_spam` boolean, required
      - `is_starred` boolean, required
      - `is_sent` boolean, required
      - `has_attachments` boolean, required
      - `labels` string[], required
      - `participants` Participant[]
        - `name` string
        - `email` string, email, required
    - `page` PageInfo, required
      - `next_cursor` string
      - `has_more` boolean, required
    - `mailbox_thread_counts` object, required
    - `revision` integer, required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)