InboxedUp - API
  1. Account
InboxedUp - API
  • Account
    • Get account overview
      GET
  • Subscriptions
    • List active subscriptions
      GET
    • Update subscription notes
      PATCH
  • Domains
    • Submit domains
      POST
    • List domains
      GET
    • Get domain
      GET
    • Remove domain
      DELETE
    • Verify domain NS propagation
      POST
    • Get batch status
      GET
  • Mailboxes
    • Request mailboxes
      POST
    • List mailbox requests
      GET
    • Get mailbox request
      GET
  • Schemas
    • Error
    • MailboxEntry
  1. Account

Get account overview

GET
/account
Returns your account profile, inbox allocations per type, and a summary of your infrastructure.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or

Responses

🟢200
application/json
Account overview
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/account' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "success": true,
    "data": {
        "customer": {
            "id": "cmlcta3bw001onul0lu4vibp2",
            "email": "you@yourdomain.com",
            "name": "Your Name",
            "createdAt": "2025-01-15T10:00:00.000Z"
        },
        "allocations": [
            {
                "type": "MICROSOFT",
                "allocated": 10,
                "used": 3,
                "remaining": 7
            },
            {
                "type": "GOOGLE",
                "allocated": 0,
                "used": 0,
                "remaining": 0
            },
            {
                "type": "SMTP",
                "allocated": 50,
                "used": 12,
                "remaining": 38
            },
            {
                "type": "SMTP_DEDICATED",
                "allocated": 0,
                "used": 0,
                "remaining": 0
            }
        ],
        "summary": {
            "totalDomains": 5,
            "activeDomains": 3,
            "pendingMailboxRequests": 2,
            "activeApiKeys": 4
        }
    }
}
Modified at 2026-03-12 08:23:25
Next
List active subscriptions
Built with