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

Returns compact message records (UID, MODSEQ, flags, size, dates) ordered by UID for efficient folder synchronization (up to 10,000 per page).

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

uidMin?integer

Minimum UID inclusive

Range1 <= value
uidMax?integer

Maximum UID inclusive

Range1 <= value
limit?integer

Maximum items to return (default 1000, max 10000)

Range1 <= value <= 10000
order?string

UID order within the page (default asc). desc pages from the newest end, for a client that must keep the NEWEST N under a row cap.

Value in"asc""desc"

Response Body

Message index page with UID validity

application/json
  1. response
messages*array<>

List of message summaries ordered by UID

uidValidity*integer

UIDVALIDITY epoch of the label

Formatint64
Example Request
curl -X GET 'https://api.open.email/api/v1/mailboxes/string/labels/string/uids'
Example Response
{
  "messages": [
    {
      "blobHash": "string",
      "flags": [
        "string"
      ],
      "id": "string",
      "keywords": [
        "string"
      ],
      "modseq": 0,
      "receivedAt": 0,
      "sentAt": 0,
      "size": 0,
      "uid": 0
    }
  ],
  "uidValidity": 0
}