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

Get Counts

Request, response and authentication details for your Mailat instance.

← All API operations
GET/api/v1/inbox/received/counts

Counts 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
curl --request GET "$MAILAT_BASE_URL/api/v1/inbox/received/counts" \
  --header "Authorization: Bearer $MAILAT_TOKEN"

Parameters

query
identityIdinteger

Omit 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-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 · 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

labelsobject
Additional 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

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