InboxKit

Check mailbox availability

GET

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

Mailboxes

Maintainer:Not configured

Check if a mailbox username is available

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.inboxkit.com/v1/api/mailboxes/availability?username&domain'

Response Example

{
    "error": false,
    "message": "Mailbox availability returned successfully",
    "available": true
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

username

string

required

Username to check availability for

domain

string

required

Domain to check username availability for

Responses

🟢200OK

application/json

Mailbox availability checked successfully

Body

error

boolean

optional

Example:

false

message

string

optional

Example:

Mailbox availability returned successfully

available

boolean

optional

Whether the username is available

Example:

true

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2025-06-17 13:00:15

Change password

Get DNS records