• Litemail Docs
    • Users
      • Retrieve User Details
        GET
    • Workspaces
      • Retrieve All Workspaces
        GET
      • Create New Workspace
        POST
      • Update Workspace
        PUT
    • Billings
      • Add Billing Details
        POST
    • Mailboxes
      • Retrieve Mailboxes
        GET
      • Assign New Mailbox to Domain
        POST
      • Get Mailbox Details
        GET
      • Update Mailbox
        PUT
      • Remove Mailbox (Next Renewal)
        DELETE
    • Payment & Wallet
      • Get Wallet Balance
        GET
      • Add Balance to Wallet
        POST
      • Enable Auto Recharge
        POST
    • Exports
      • Export Mailboxes
        POST
      • Add Third Party Account Details
        POST
      • Update Third Party Account Details
        PUT
    • Subscriptions
      • Get All Subscriptions
        GET
      • Cancel Subscription
        DELETE
      • Upgrade Subscription
        PUT
    • Domains
      • Retrieve Domains
        GET
      • List Assignable Domains
        GET
      • Add DMARC Records
        POST
      • Add Domain Forwarding
        POST
      • Remove Domain Forwarding
        DELETE
      • Get Name Servers
        GET
      • Verify Name Server Propagation
        GET
      • Connect Domains with Zapmail
        POST
      • Enable Email Forwarding
        POST
      • Remove Email Forwarding
        DELETE
      • Enable Catch-All Emails
        POST
      • Remove Catch-All Emails
        DELETE
      • Check DNS Records
        GET
      • Remove Unused Domain
        DELETE
      • Get Available Domains for Registration
        GET
      • Get Domain Purchase Payment Link
        GET
    • 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 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