---
title: "List mailboxes"
method: GET
path: "/v0/mailboxes"
tags: ["Mailboxes"]
---

# List mailboxes

`GET /v0/mailboxes`

List all mailboxes

## Query parameters

- `active` boolean, nullable — Filter for effectively active mailboxes (marked active with a live subscription)
- `email_addresses` string, nullable — Email addresses of the mailboxes to return (comma-delimited)
- `limit` integer, nullable — The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used
- `mailbox_types` string, nullable — Comma-delimited list of mailbox types to filter by
- `marked_active` boolean, nullable — Filter for mailboxes marked active
- `message_source_id` string, nullable — ID of the message source the mailboxes belong to
- `offset` integer, nullable — The (zero-based) offset of the first mailbox to return
- `search` string, nullable — Search across mailbox names and email addresses
- `sub_error_types` string, nullable — Comma-delimited list of subscription error types to filter by

## Response `200`

OK

- HandlersV0ListMailboxesResponse
  - `active` integer — Total number of active matching filters
  - `count` integer — Count of results for this page
  - `mailboxes` HandlersV0Mailbox[] — List of mailboxes
    - `active` boolean — Whether the mailbox is active
    - `email_address` string, required — Mailbox email address
    - `id` string, uuid, required — Mailbox ID
    - `subscription_error_status` string, nullable — Error type encountered when last trying to subscribe to change notifications from the provider (null if most recently successful)
  - `total` integer — Total number of results available

---

[API](https://skmtc.net/sublime/apis/sublime-platform-api.md) · [All operations](https://skmtc.net/sublime/apis/sublime-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sublime/sublime-platform-api/revisions/d5df82850357/schema)