---
title: "Get a live email subscription ticket"
method: GET
path: "/v1/mailboxes/{mailbox_id}/email/subscription"
tags: ["Email settings"]
---

# Get a live email subscription ticket

`GET /v1/mailboxes/{mailbox_id}/email/subscription`

## Request

- Base URL: `https://api.revdoku.com`
- URL: `https://api.revdoku.com/v1/mailboxes/{mailbox_id}/email/subscription`
- Auth: HTTP bearer

Requires mailbox read permission. Connect to websocket_url with email_subscription_token=TOKEN within 60 seconds, then subscribe to EmailReceivedChannel. Catch up with the email list cursor after every connect.

## Path parameters

- `mailbox_id` string, required

## Query parameters

- `account_id` string

## Response `200`

Success

- object
  - `success` true, required
  - `data` object, required
    - `subscription` EmailSubscription, required
      - `token` string, required
      - `expires_in` 60, required
      - `channel` 'EmailReceivedChannel', required
      - `account_id` string, required
      - `mailbox_id` string, required
      - `websocket_url` string, uri, required: Base WebSocket endpoint. Append email_subscription_token as a query parameter.

## Other responses

- `default`: Request failed. See error.code. Any 429 or 503 response with Retry-After (for example 503 EMAIL_LABELING_PENDING or 503 EMAIL_INDEX_BUILDING): wait that many seconds, then try the read again. 429 EMAIL_SEND_RATE_LIMITED has no Retry-After. Never retry EMAIL_LOOP_DETECTED.

---

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