1. Users
  • Litemail
    • Litemail Docs
    • Users
      • Retrieve User Details
        GET
    • 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. Users

Retrieve User Details

GET
/v1/users
This endpoint allows you to fetch information about the currently authenticated user, including their domains, mailboxes, subscriptions, and transaction history.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.litemail.ai/v1/users' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK
application/json
Success - User details retrieved successfully
Bodyapplication/json

Examples
{
    "status": 200,
    "message": "User details fetched successfully",
    "data": {
        "id": "cmg9jatbj0000jv04cejuz12b",
        "email": "baigt0449@gmail.com",
        "firstName": "Tayyab",
        "lastName": "Baig",
        "fullName": "Tayyab Baig",
        "clerkUserId": "user_33W4jI02pnCzFAWqLuuWfr1zTuM",
        "stripeCustomerId": "cus_TA87awB83Wo93a",
        "balance": 0,
        "stats": {
            "totalDomains": 1,
            "totalMailboxes": 6,
            "activeSubscriptions": 0,
            "totalTransactions": 0
        },
        "domains": [
            {
                "id": "cmg9l788c0001la04ctg7t1j4",
                "name": "b2bforcelabs.com",
                "status": "NOT_ACTIVE",
                "platform": "GOOGLE",
                "createdAt": "2025-10-02T15:45:32.267Z"
            }
        ],
        "mailboxes": [
            {
                "id": "cmg9l78m8000bla04a6onx0ih",
                "username": "Mary",
                "fullName": "Mary",
                "status": "PENDING",
                "createdAt": "2025-10-02T15:45:32.768Z"
            }
        ],
        "activeSubscription": null,
        "recentTransactions": [],
        "createdAt": "2025-10-02T14:52:20.334Z",
        "updatedAt": "2025-10-02T14:52:20.334Z"
    }
}
🟠401Unauthorized
🟠404Not Found
🔴500Internal Server Error
Previous
Litemail Docs
Next
Retrieve All Workspaces
Built with