Skip to Content
GET
/api/v1/mailboxes/{mailboxId}/labels/{label}/vanished

Returns UIDs of messages expunged from the label since a specified change sequence (MODSEQ) number.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

mailboxId*string

Mailbox ULID identifier

label*string

Label or folder name (e.g. INBOX, Archive, custom)

Query Parameters

changedSince?|

Find UIDs expunged after this MODSEQ change sequence number

Range0 <= value
limit?integer

Maximum UIDs to return per page (max 2000)

Range1 <= value <= 2000
cursor?string

Pagination cursor for next page

Response Body

List of vanished UIDs and current highest change sequence number

application/json
  1. response
highestModseq*integer

Current RFC 7162 HIGHESTMODSEQ of the label

Formatint64
nextCursor?string

Opaque cursor for the next page; absent on the last page

vanished*array<>

List of expunged UIDs since the requested modseq

Example Request
curl -X GET 'https://api.open.email/api/v1/mailboxes/string/labels/string/vanished'
Example Response
{
  "highestModseq": 0,
  "nextCursor": "string",
  "vanished": [
    0
  ]
}