Get Counts
Request, response and authentication details for your Mailat instance.
/api/v1/inbox/received/countsCounts for the caller's owned mailbox. inboxUnread is the main Inbox unread badge; dmarcReports and dmarcReportsUnread count the dedicated folder. unread retains its global non-trash meaning and includes unread reports.
Authentication & compatibility
Use a scoped bearer API key with email:read. The key is bound to its user and organization.
SES email workflow and its stored mailbox/configuration data. Provider actions require configured AWS permissions and verified owned domains; receiving is opt-in.
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 GET "$MAILAT_BASE_URL/api/v1/inbox/received/counts" \
--header "Authorization: Bearer $MAILAT_TOKEN"Parameters
identityIdintegerOmit or use zero for the unified mailbox; otherwise count an owned identity.
minimum: 0
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-RemainingintegerRemaining requests in this API key's current minute window (present for API-key authentication).
minimum: 0
application/json
responseobjectFields
codeintegerrequireddataall of · nullableVariant 1objectFields · model.InboxCountsResponse
dmarcReportsinteger (int64)Messages in the dedicated DMARC Reports folder.
minimum: 0
dmarcReportsUnreadinteger (int64)Unread messages in the dedicated DMARC Reports folder.
minimum: 0
draftsinteger (int64)inboxinteger (int64)inboxUnreadinteger (int64)Unread messages in the main Inbox only.
minimum: 0
labelsobjectAdditional valuesinteger (int64)sentinteger (int64)spaminteger (int64)starredinteger (int64)trashinteger (int64)unreadinteger (int64)Global unread total excluding Trash; includes Spam and unread DMARC reports.
minimum: 0
messagestringrequired400 · Invalid input
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired401 · Missing, expired or revoked authentication
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired403 · Insufficient permission
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired404 · Resource not found
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired409 · Conflict or changed idempotency payload
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired410 · Recovery cursor expired; resynchronize
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired429 · Rate limit exceeded; respect Retry-After
Header: Retry-AfterintegerSeconds until the next fixed-minute request window.
minimum: 1
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired500 · Internal failure; retain the idempotency key
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired