1. Litemail
  • Litemail
    • Litemail Docs
    • Users
      • Retrieve User Details
    • Workspaces
      • Retrieve All Workspaces
      • Create New Workspace
      • Update Workspace
    • Billings
      • Add Billing Details
    • Mailboxes
      • Retrieve Mailboxes
      • Assign New Mailbox to Domain
      • Get Mailbox Details
      • Update Mailbox
      • Remove Mailbox (Next Renewal)
    • Payment & Wallet
      • Get Wallet Balance
      • Add Balance to Wallet
      • Enable Auto Recharge
    • Exports
      • Export Mailboxes
      • Add Third Party Account Details
      • Update Third Party Account Details
    • Subscriptions
      • Get All Subscriptions
      • Cancel Subscription
      • Upgrade Subscription
    • Domains
      • Retrieve Domains
      • List Assignable Domains
      • Add DMARC Records
      • Add Domain Forwarding
      • Remove Domain Forwarding
      • Get Name Servers
      • Verify Name Server Propagation
      • Connect Domains with LiteMail AI
      • Enable Email Forwarding
      • Remove Email Forwarding
      • Enable Catch-All Emails
      • Remove Catch-All Emails
      • Check DNS Records
      • Remove Unused Domain
      • Get Available Domains for Registration
      • Get Domain Purchase Payment Link
    • DNS
      • Get DNS Records
      • Add DNS Record
      • Update DNS Record
      • Delete DNS Record
    • apikeys testing
      • generate key by login first
    • Connect Inbox
      • connect-inboxes
  • LiteMail API v3
    • Users
      • Retrieve User Details
    • Domains
      • Retrieve Domains
      • Purchase/Register a New Domain
      • List Assignable Domains
      • Add DMARC Records
      • Add Domain Forwarding
      • Remove Domain Forwarding
      • Get Name Servers
      • Verify Name Server Propagation
      • Connect Domains with LiteMail
      • Enable Email Forwarding
      • Remove Email Forwarding
      • Enable Catch-All Emails
      • Remove Catch-All Emails
      • Check DNS Records
      • Get Domain Details
      • Remove Unused Domain
      • Get Available Domains for Registration
      • Get Domain Purchase Payment Link
    • Mailboxes
      • Retrieve Mailboxes
      • Assign New Mailbox to Domain
      • Get Mailbox Details
      • Update Mailbox
      • Remove Mailbox (Next Renewal)
      • Get Warmup Analytics for Mailboxes
    • Workspaces
      • Retrieve All Workspaces
      • Create New Workspace
      • Update Workspace
    • Billings
      • Add Billing Details
    • Payment & Wallet
      • Get Wallet Balance
      • Add Balance to Wallet
      • Enable Auto Recharge
    • Wallet
      • Add Credit to Wallet
      • List Billing Invoices
    • Exports
      • Export Mailboxes
      • Add Third Party Account Details
      • Update Third Party Account Details
      • Connect Inboxes (Export to Platform)
    • Subscriptions
      • Get All Subscriptions
      • Cancel Subscription
      • Upgrade Subscription
    • DNS
      • Get DNS Records
      • Create DNS Record
      • Update DNS Record
      • Delete DNS Record
    • Tags
      • List Tags
      • Create Tag
      • Update Tag
      • Delete Tag
    • MailBoxes
      • Assign Mailboxes to Domain
    • Placement
      • List Placement Tests
      • Create Placement Test
    • Dashboard
      • Get Dashboard Overview
      • Get Mailbox Status Counts
    • Export History
      • List Export History
      • Create Export History Record
    • Cloudflare
      • Get Cloudflare Credentials & Zones
      • Save Credentials or Connect Domain
    • Webhooks
      • List Registered Webhooks
      • Register a New Webhook Endpoint
      • Delete a Webhook
  1. Litemail

Litemail Docs

Introduction#

Welcome to Litemail — a modern email infrastructure built to help developers integrate, manage, and scale their email workflows. Whether you’re managing domains, creating workspaces, or handling subscriptions, the Litemail API gives you the flexibility to automate and extend your email services with ease.
This documentation will guide you through everything you need to start building on Litemail.

Authentication#

Using Clerk JWT Tokens#

All API requests require authentication with a Clerk-issued JWT token. Include it in the Authorization header as follows:
Authorization: Bearer <your-jwt-token>
If the token is missing or invalid, the API will return a 401 Unauthorized error.

Workspace Scoping#

Some endpoints are scoped to specific workspaces. To target a workspace, include the following header:
x-workspace-key: <workspace-id>
If omitted, requests will default to the primary workspace associated with the authenticated user.

Base URL#

All API requests should be made to:
https://api.litemail.app/v1

Rate Limits#

To maintain performance and reliability, the Litemail API enforces rate limits:
5 requests per second per user (soft limit)
Burst allowance may temporarily allow short spikes.
If you exceed the rate limit, you’ll receive a 429 Too Many Requests response. Implement retries with exponential backoff to avoid interruptions.

Common Response Structure#

Every successful response follows a consistent structure:
{
  "status": 200,
  "message": "Action completed successfully",
  "data": { ... }
}
Error responses include an HTTP status code and details about what went wrong:
{
  "status": 401,
  "message": "Unauthorized - Invalid or missing token"
}

Next Steps#

Explore the Workspaces API to create and manage workspaces.
Use the Domains API to configure custom email domains.
Check out the Subscriptions API to manage plans and upgrades.
Litemail is designed to integrate seamlessly into your workflows — start building today!
Next
Retrieve User Details
Built with