Zapmail

Get Mailbox Details by ID

GET

/v1/mailbox/details

Use this endpoint to retrieve the details of a specific mailbox by its ID.

Request

Query Params

string

required

Example:

Header Params

x-auth-zapmail

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://api.zapmail.ai/api/v1/mailbox/details?id={{mailbox-id}}' \
--header 'x-auth-zapmail: '

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "status": 200,
    "message": "Mailbox fetched successfully",
    "data": {
        "mailbox": {
            "id": "8f79c3e4-456b-47a4-9df9-bc1a7c123abc",
            "username": "alex.smith",
            "firstName": "Alex",
            "lastName": "Smith",
            "status": "INACTIVE",
            "profilePicture": null,
            "domain": "techzone.com",
            "domainId": "3a204f5f-8d36-48f8-b00d-9b543a8be31f",
            "assignedOn": "2025-01-05T10:15:22.000Z",
            "expireOn": "2025-02-05T10:15:22.000Z",
            "createdAt": "2025-01-05T10:15:22.000Z"
        }
    }
}

Modified at 2025-01-30 13:13:39

Retrieve All Mailboxes

Assign New Mailboxes to Domains