List mailboxes

POST

https://api.inboxkit.com/v1/api/mailboxes/list

Maintainer:Not configured

Get a paginated list of mailboxes for the workspace

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/list' \
--header 'X-Workspace-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "limit": 10,
    "keyword": "",
    "domain": "",
    "domain_uid": "",
    "platform": "GOOGLE",
    "status": "active",
    "uids": []
}'

Response Example

{
    "error": false,
    "message": "Mailboxes retrieved successfully",
    "mailboxes": [
        {
            "uid": "e88ae415-fe99-4831-b3fe-cdf2e7e25925",
            "domain_name": "myzyng.net",
            "forwarding_email": "",
            "first_name": "marvin",
            "last_name": "kassulke",
            "profile_picture": null,
            "username": "marvinkassulke",
            "platform": "GOOGLE",
            "status": "active",
            "is_admin": false,
            "tags": [],
            "sequencers": [],
            "createdAt": "2025-06-15T11:53:54.260Z",
            "updatedAt": "2025-06-15T12:12:57.506Z",
            "renewal_date": "1970-01-01T00:00:00.000Z",
            "mailbox_update_status": "queued",
            "sequencer_status": "queued",
            "dns_propagation_status": "queued",
            "renewal_cycle": "monthly",
            "renewal_status": "na"
        }
    ],
    "total": 0,
    "pages": 0,
    "current_page": 0,
    "limit": 0
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Mailboxes list retrieved successfully

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2025-08-05 09:05:13

Check nameservers propagation

Show mailbox credentials