List Mailboxes for a Specific User

This endpoint retrieves a paginated list of mailboxes associated with a specific user. It supports filtering through a search query based on domain name, first name, last name, and username.

Query Parameters

Name	Type	Description
`userId`	`string`	The unique ID of the user whose mailboxes need to be fetched. (Required)
`limit`	`number`	The number of records to return per page. Default is 50.
`page`	`number`	The page number to retrieve. Default is 1.
`search`	`string`	A search keyword to filter mailboxes by `email address`, `domain name`, `first name`, `last name`, or `username`.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Mailbox details fetched successfully",
    "data": {
        "user": {
            "id": "PWM7Y25RYZ450YNM8K8FX9GK5AHX",
            "firstName": "jake",
            "lastName": "goa",
            "email": "jake@company.com"
        },
        "mailboxes": [
            {
                "firstName": "john",
                "lastName": "doe",
                "profilePicture": "https://cdn.zapmail.ai/mailboxes/James-Carter-SelectAll-1756754834597.jpg",
                "username": "john.s",
                "domain": "gettierservices.org",
                "email": "john.s@gettierservices.org",
                "password": "3@RDjKv@IGi7H4",
                "isAdmin": true,
                "appPassword": "pony ppos micx xycp",
                "authenticatorSecret": null,
                "serviceProvider": "GOOGLE",
                "id": "PWM7Y25RYZ450YNM8K8FX9GK5AHF",
                "expireOn": "2025-12-31T23:59:59Z"
            },
            {
                "firstName": "jean",
                "lastName": "doe",
                "profilePicture": "https://cdn.zapmail.ai/mailboxes/James-Carter-SelectAll-1756754834597.jpg",
                "username": "jean.s",
                "domain": "topkkl.org",
                "email": "jean.s@topkkl.org",
                "password": "1B1FNyg0#$PF9f",
                "isAdmin": false,
                "appPassword": "rena ppos micx xycp",
                "authenticatorSecret": null,
                "serviceProvider": "MICROSOFT",
                "id": "PWM7Y25RYZ450YNM8K8FHUGK5AHF",
                "expireOn": "2025-12-31T23:59:59Z"
            }
        ],
        "pagination": {
            "totalSearchedCount": 138,
            "currentPage": 1,
            "nextPage": 2,
            "totalPages": 69
        }
    }
}

Get mailboxes for user

List Mailboxes for a Specific User#

Query Parameters#

Request

Request Code Samples

Responses

List Mailboxes for a Specific User

Query Parameters