InboxKit
  1. Mailboxes
InboxKit
  • Introduction
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      GET
    • List assignable domains
      GET
    • Set DMARC policy
      POST
    • Remove DMARC policy
      DELETE
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
  • Mailboxes
    • List mailboxes
      GET
    • Show mailbox credentials
      GET
    • Get mailbox details
      GET
    • Buy mailboxes
      POST
    • Check mailbox status
      POST
    • Cancel mailboxes
      POST
    • Update mailbox
      POST
    • Update mailbox profile picture
      POST
    • Generate TOTP
      GET
    • Change username
      POST
    • Change password
      POST
    • Check mailbox availability
      GET
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  1. Mailboxes

Get mailbox details

GET
https://api.inboxkit.com/v1/api/mailboxes/details
Mailboxes
Maintainer:Not configured
Retrieve detailed information for a specific mailbox
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.inboxkit.com/v1/api/mailboxes/details?uid' \
--header 'X-Workspace-Id;'
Response Response Example
{
    "error": false,
    "message": "Mailbox details retrieved successfully",
    "mailbox": {
        "uid": "string",
        "first_name": "John",
        "last_name": "Doe",
        "username": "john.doe",
        "platform": "GOOGLE",
        "status": "string",
        "domain": "example.com",
        "profile_picture": "string",
        "sequencers": [
            {
                "name": "string",
                "status": "string"
            }
        ]
    }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
uid
string 
required
Mailbox UID
Header Params
X-Workspace-Id
string <uuid>
required
Workspace identifier

Responses

🟢200OK
application/json
Mailbox details retrieved successfully
Body
error
boolean 
optional
Example:
false
message
string 
optional
Example:
Mailbox details retrieved successfully
mailbox
object 
optional
uid
string 
optional
Mailbox UID
first_name
string 
optional
Example:
John
last_name
string 
optional
Example:
Doe
username
string 
optional
Example:
john.doe
platform
enum<string> 
optional
Allowed values:
GOOGLEMICROSOFT
status
string 
optional
domain
string 
optional
Example:
example.com
profile_picture
string  | null 
optional
sequencers
array [object {2}] 
optional
Associated sequencers
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-06-20 08:29:36
Previous
Show mailbox credentials
Next
Buy mailboxes
Built with