Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Get Inbox

Request, response and authentication details for your Mailat instance.

← All API operations
GET/api/v1/inbox

GetInbox returns unified inbox with emails from all identities GET /api/v1/inbox

Authentication & compatibility

Use a scoped bearer API key with email:read. The key is bound to its user and organization.

Legacy Stalwart / JMAP dependency. This is not the SES inbox automation path. Start with receiving mail through SES.

Legacy mailbox operation requiring configured Stalwart/JMAP accounts. This is not the SES received-mail API; use /inbox/received and /inbox/changes for SES automation.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request GET "$MAILAT_BASE_URL/api/v1/inbox" \
  --header "Authorization: Bearer $MAILAT_TOKEN"

Parameters

query
flaggedboolean
query
identityIdinteger (int64)
query
mailboxIdstring
query
pageinteger (int64)

Default: 1

query
pageSizeinteger (int64)

Default: 50

query
searchstring
query
unreadboolean

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success
Header: X-RateLimit-Remaininginteger

Remaining requests in this API key's current minute window (present for API-key authentication).

minimum: 0

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · service.UnifiedInboxResponse
emailsarray
Each itemobject
Fields · service.UnifiedEmail
blobIdstring
ccarray
Each itemobject
Fields · service.EmailAddress
emailstring
namestring
domainColorstring
domainIdinteger (int64)
domainNamestring
fromarray
Each itemobject
Fields · service.EmailAddress
emailstring
namestring
hasAttachmentboolean
idstring
identityEmailstring
identityIdinteger (int64)
identityUuidstring
isDraftboolean
isFlaggedboolean
isReadboolean
keywordsobject
Additional valuesboolean
mailboxIdsobject
Additional valuesboolean
previewstring
receivedAtstring (date-time)
sizeinteger (int64)
subjectstring
threadCountinteger (int64)
threadIdstring
toarray
Each itemobject
Fields · service.EmailAddress
emailstring
namestring
hasMoreboolean
pageinteger (int64)
pageSizeinteger (int64)
totalinteger (int64)
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract