v1

latestOpenAPI 3.0.02026-07-13474670.4 KB

Account

Get current account

Get information about the account for this API key.

get/me

Response

Current User Information

_idstring

username

emailstring email

email address

invoiceEmailstring email

email address

capturePrivateboolean

Setting which will apply a star to all captured emails.

messageLimitinteger

Maximum allowed message history (starred messages + all messages on enhanced addresses and domains)

privateDomaininteger

Number of custom domain that the account is entitled to but has not yet reserved

privateAddressCreditsinteger

Number of enhanced addresses that the account is entitled to but has not yet reserved

whitelistAccess0 | 1

Flag indicating whether account is allowed to request adding IPs to the global allow-list.

moAPICountinteger

Approximate number of total API calls made by the account this month

apiMonthlyLimitinteger

Number of API calls allowed monthly

billingHoldstring

When present, indicates the account has past-due invoices and service is disabled

disabledstring

When present, indicates a disabled account

recentsEmailString[]

The most recent email addresses viewed by this account in the UI

labelsstring[]

Inbox labels created by the account

companystring

Company name associated with account

addressstring

Company address associated with account

firehoseinteger

Entitlement flag indicating whether the account has access to the Firehose Web Socket API

allowPublicDomains0 | 1

Entitlement flag indicating whether the account has access to Public Domains

viewAnalytics0 | 1

Flag indicating whether account is allowed to view analytics

apiAccess0 | 1

Flag indicating whether account has access to API

wsDomain0 | 1

manyKeys0 | 1

internalUnlimited0 | 1

lastLoginstring date

Date in ISO 8601

allowMultipleUsers0 | 1

userLimitinteger

Number of users

stripeIdstring

moAPIDisabledinteger

moAPILimitWarningEmailinteger

apiKeyNamestring

Example response

{
  "_id": "my_username",
  "email": "anything_123@mailsac.com",
  "invoiceEmail": "anything_123@mailsac.com",
  "messageLimit": 1000,
  "privateAddressCredits": 100,
  "recents": [
    "anything_123@mailsac.com"
  ],
  "lastLogin": "1985-04-12T23:20:50.52Z"
}