Zapmail

Get Mailbox Details by ID

GET

/v2/mailboxes

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

Request

Query Params

string

required

Header Params

x-auth-zapmail

string

required

Example:

x-workspace-key

string

required

Example:

x-service-provider

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zapmail.ai/api/v2/mailboxes?id=' \
--header 'x-auth-zapmail: ' \
--header 'x-workspace-key: ' \
--header 'x-service-provider: GOOGLE'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
  "status": 200,
  "message": "Mailbox fetched successfully",
  "data": {
    "mailbox": {
      "id": "abcd1234-5678-90ef-ghij-klmn12345678",
      "username": "john.doe",
      "firstName": "John",
      "lastName": "Doe",
      "status": "ACTIVE",
      "profilePicture": null,
      "domain": "example1.com",
      "domainId": "12345abc-defg-6789-hijk-lmnopqrstu12",
      "assignedOn": "2025-01-10T09:00:00.000Z",
      "expireOn": "2025-02-10T09:00:00.000Z",
      "createdAt": "2025-01-10T09:00:00.000Z",
      "appPassword": "nfd2 jk43 4jas hfdj",
      "secret": "gger u434 ebt6 kktm st4d hj41 62tz fe24"
    }
  }
}

Retrieve All Mailboxes

Assign New Mailboxes to Domains