List message sync index for a label
Returns compact message records (UID, MODSEQ, flags, size, dates) ordered by UID for efficient folder synchronization (up to 10,000 per page).
bearerAuthAuthorizationBearer <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: [].
mailboxId*stringMailbox ULID identifier
label*stringLabel or folder name (e.g. INBOX, Archive, custom)
uidMin?integerMinimum UID inclusive
1 <= valueuidMax?integerMaximum UID inclusive
1 <= valuelimit?integerMaximum items to return (default 1000, max 10000)
1 <= value <= 10000order?stringUID 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.
"asc""desc"Message index page with UID validity
application/json- response
messages*array<>List of message summaries ordered by UID
uidValidity*integerUIDVALIDITY epoch of the label
int64curl -X GET 'https://api.open.email/api/v1/mailboxes/string/labels/string/uids'{
"messages": [
{
"blobHash": "string",
"flags": [
"string"
],
"id": "string",
"keywords": [
"string"
],
"modseq": 0,
"receivedAt": 0,
"sentAt": 0,
"size": 0,
"uid": 0
}
],
"uidValidity": 0
}Update flags, labels and keywords for every… PATCH
Keyed on the label's numeric `id` — as `GET /labels` and `POST /labels` report it — rather than on its name. The id survives a rename (it is what JMAP…
List vanished (expunged) message UIDs GET
Returns UIDs of messages expunged from the label since a specified change sequence (MODSEQ) number.