InboxKit

List mailboxes

GET

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

Mailboxes

Maintainer:Not configured

Get a paginated list of mailboxes for the workspace

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.inboxkit.com/v1/api/mailboxes/list?page&limit&keyword&domain&domain_uid&platform&status' \
--header 'X-Workspace-Id;'

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 ********************

Query Params

page

integer

optional

Page number for pagination

>= 1

Default:

limit

integer

optional

Number of items per page

>= 1<= 100

Default:

keyword

string

optional

Search keyword for filtering mailboxes

domain

string

optional

Filter by domain

domain_uid

string

optional

Filter by domain uid

platform

enum<string>

optional

Filter by platform

Allowed values:

GOOGLEMICROSOFT

Default:

GOOGLE

status

string

optional

Filter by status

Header Params

X-Workspace-Id

string <uuid>

required

Workspace identifier

Responses

🟢200OK

application/json

Mailboxes list retrieved successfully

Body

error

boolean

optional

Example:

false

message

string

optional

Example:

Mailboxes retrieved successfully

mailboxes

array [object {20}]

optional

uid

string

optional

Mailbox UID

Example:

e88ae415-fe99-4831-b3fe-cdf2e7e25925

domain_name

string

optional

Example:

myzyng.net

forwarding_email

string

optional

Example:

first_name

string

optional

Example:

marvin

last_name

string

optional

Example:

kassulke

profile_picture

string | null

optional

Example:

null

username

string

optional

Example:

marvinkassulke

platform

enum<string>

optional

Allowed values:

GOOGLEMICROSOFT

Example:

GOOGLE

status

string

optional

Example:

active

is_admin

boolean

optional

Example:

false