Zapmail
latest
  • latest
  • v1
  1. users
Zapmail
latest
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
      POST
    • Add third party account details
      POST
    • Update third party account details
      PUT
  • subscriptions
    • Get all subscriptions
      GET
    • Cancel subscription
      POST
    • Upgrade existing subscription
      POST
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  1. users

Retrieve User Details

GET
/v2/users
This endpoint allows you to fetch information about a user.

Request

Header Params
x-auth-zapmail
string 
required

Request 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 'https://api.zapmail.ai/api/v2/users' \
--header 'x-auth-zapmail;'

Responses

🟢200Success
application/json
Body
status
integer 
required
message
string 
required
data
object 
required
id
string 
required
email
string 
required
firstName
string 
required
lastName
string 
required
activePlan
string 
required
planEndsOn
string 
required
purchasedMailboxes
integer 
required
assignedMailboxes
integer 
required
userCreatedAt
string 
required
walletBalance
number 
required
Balance amount in USD ($)
Example
{
    "status": 200,
    "message": "User details fetched successfully",
    "data": {
        "id": "12345678-abcd-4efg-90hi-1234567890jk",
        "email": "example@domain.com",
        "firstName": "John",
        "lastName": "Doe",
        "activePlan": "Premium",
        "planEndsOn": "2025-03-10T15:00:00.000Z",
        "purchasedMailboxes": 120,
        "assignedMailboxes": 85,
        "userCreatedAt": "2023-01-15T08:30:00.000Z",
        "walletBalance": 100.5
    }
}
🟠401Unauthorized
Modified at 2025-06-25 13:42:34
Previous
Zapmail Docs
Next
Retrieve all workspaces
Built with