Account

Retrieve account

Retrieve your account information.

Authentication: This endpoint supports both API token authentication and alias credentials authentication.

  • User Account (API Token): When authenticated with your API token, this endpoint returns your user account information including plan details, email, and API token.

  • Alias Account (Alias Credentials): When authenticated with alias credentials (email and generated password), this endpoint returns alias/mailbox information including storage used/quota and a nested settings object (mail special folders, label settings, and alias defaults). This is useful for IMAP/POP3/CalDAV/CardDAV clients to check storage status and preferences.

get/v1/account

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/account
  • Auth: one of:
    • HTTP basic
    • HTTP basic

Response

Account retrieved successfully

OR

Example response

{
  "sessions": [],
  "has_newsletter": true,
  "plan": "free",
  "email": "test1@test1.com",
  "max_quota_per_alias": 10737418240,
  "full_email": "test1@test1.com",
  "display_name": "test1@test1.com",
  "otp_enabled": false,
  "last_locale": "en",
  "address_country": "None",
  "id": "683fb2e81cc5d449a0d4cd9d",
  "object": "user",
  "locale": "en",
  "created_at": "2025-06-04T02:43:52.646Z",
  "updated_at": "2025-06-04T02:43:55.350Z",
  "address_html": "",
  "api_token": "15ac16ae21784aa2cb4d5508"
}

Changes

No recorded changes to this operation across all 1 revision of this API.