Skip to main content
GET
Get email usage

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Path Parameters

workspaceId
string
required

Workspace id

Response

Email send usage for the current period

workspace_id
string
plan
string
plan_name
string
period_start
string<date-time>
period_end
string<date-time>
quota
number | null

Plan email send quota (recipient count); null if unlimited

used
number
remaining
number | null
legacy_sent_count
number

Pre-ledger sent recipients included in used

mailboxes
object[]