1. Users
  • 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
  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 --request GET '/v1/users' \
--header 'x-api-key: <api-key>'

Responses

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

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