Retrieve User Details

GET

/v2/users

Use this endpoint to fetch details of the authenticated user, including their active plan, mailbox usage, and wallet balance.

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zapmail.ai/api/v2/users' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success

application/json

Body

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-10-14 09:19:57

Zapmail Docs

Retrieve all workspaces