Retrieve All Mailboxes

Request

Query Params

page

string

optional

Example:

1

limit

string

optional

Example:

10

Header Params

x-auth-zapmail

string

required

Example:

x-workspace-key

string

optional

Example:

x-service-provider

string

optional

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.zapmail.ai/api/v2/mailboxes/list?page=1&limit=10' \
--header 'x-auth-zapmail: ' \
--header 'x-workspace-key: ' \
--header 'x-service-provider: GOOGLE'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "status": 200,
    "message": "Mailboxes fetched successfully",
    "data": {
        "totalSearchedCount": 50,
        "currentPage": 1,
        "nextPage": 2,
        "totalPages": 2,
        "purchasedMailboxes": 500,
        "totalAssignedMailboxes": 20,
        "totalActiveMailboxes": 10,
        "availableMailboxes": 480,
        "domains": [
            {
                "id": "12345abc-defg-6789-hijk-lmnopqrstu12",
                "domain": "example1.com",
                "status": "ACTIVE",
                "mailboxes": [
                    {
                        "id": "abcd1234-5678-90ef-ghij-klmn12345678",
                        "username": "john.doe",
                        "firstName": "John",
                        "lastName": "Doe",
                        "status": "ACTIVE",
                        "profilePicture": null,
                        "domain": "example1.com",
                        "appPassword": "nfd2 jk43 4jas hfdj",
                        "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",
                        "secret": "gger u434 ebt6 kktm st4d hj41 62tz fe24"
                    }
                ]
            },
            {
                "id": "6789xyz-wxyz-4567-klmn-7890abcdef12",
                "domain": "example2.net",
                "status": "ACTIVE",
                "mailboxes": [
                    {
                        "id": "xyz1234-5678-90ab-cdef-ghijk9876543",
                        "username": "jane.smith",
                        "firstName": "Jane",
                        "lastName": "Smith",
                        "status": "IN_PROGRESS",
                        "profilePicture": null,
                        "appPassword": null,
                        "domain": "example2.net",
                        "domainId": "6789xyz-wxyz-4567-klmn-7890abcdef12",
                        "assignedOn": "2025-01-12T11:00:00.000Z",
                        "expireOn": "2025-02-12T11:00:00.000Z",
                        "createdAt": "2025-01-12T11:00:00.000Z",
                        "secret": null
                    }
                ]
            }
        ]
    }
}