List messages in a label by UID
Returns messages in a label ordered by UID, optionally filtered by a minimum and maximum UID range.
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 messages to return (default 25, max 1000)
1 <= value <= 1000Messages with per-label UID and validity epoch
application/json- response
messages*array<>List of message metadata summaries
uidValidity*integerUIDVALIDITY epoch of the label
int64curl -X GET 'https://api.open.email/api/v1/mailboxes/string/labels/string/messages'{
"messages": [
{
"auth": {
"arc": "string",
"dkim": "string",
"dmarc": "string",
"junk": true,
"spf": "string"
},
"bcc": [
{
"email": "string",
"name": "string"
}
],
"blobGen": "string",
"blobHash": "string",
"cc": [
{
"email": "string",
"name": "string"
}
],
"deliveryMeta": {
"property1": null,
"property2": null
},
"deliveryState": "queued",
"envelopeFrom": "string",
"envelopeTo": "string",
"flags": [
"string"
],
"from": [
{
"email": "string",
"name": "string"
}
],
"hasAttachment": true,
"id": "string",
"inReplyTo": "string",
"keywords": [
"string"
],
"labels": [
{
"deleted": true,
"modseq": 0,
"name": "string",
"uid": 0,
"uidValidity": 0
}
],
"messageIdHeader": "string",
"modseq": 0,
"receivedAt": 0,
"referencesIds": [
"string"
],
"restoresTo": [
"string"
],
"sentAt": 0,
"size": 0,
"snippet": "string",
"subject": "string",
"threadId": "string",
"to": [
{
"email": "string",
"name": "string"
}
],
"uid": 0
}
],
"uidValidity": 0
}Delete a custom label, by id DELETE
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…
Update flags, labels and keywords for every… PATCH
Applies one patch to a UID RANGE of this label — the write twin of GET /labels/{label}/messages, and the way to act on a whole folder without naming its…