Zapmail
v1
  • latest
  • v1
  1. mailbox
Zapmail
v1
  • 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
  • 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
  • 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
      POST
  • subscriptions
    • Get all subscriptions
      GET
    • Cancel subscription
      POST
    • Upgrade existing subscription
      POST
  • domains
    • Retrieve All Domains
      GET
    • List Assignable Domains
      GET
    • Add DMARC record
      POST
    • Add Domain forwarding
      POST
    • Get Name servers to connect domain
      POST
    • Verify Name Server Propagation
      POST
    • Connect Domain with Zapmail
      POST
    • Enable email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Enable catch all emails
      POST
    • Remove catch all emails
      DELETE
    • Check DNS records
      POST
    • Remove unused domains
      DELETE
    • Get available domains for registration
      POST
    • Get domains purchase payment link
      POST
  1. mailbox

Retrieve All Mailboxes

GET
/v1/mailbox/list
This endpoint lets you fetch a list of all mailboxes.

Request

Header Params
x-auth-zapmail
string 
required
Example:
{{x-auth-zapmail}}

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/v1/mailbox/list' \
--header 'x-auth-zapmail: '

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",
                        "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"
                    }
                ]
            },
            {
                "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,
                        "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"
                    }
                ]
            }
        ]
    }
}
Modified at 2025-01-30 13:13:33
Previous
Add Billing Details
Next
Get Mailbox Details by ID
Built with