Get Dashboard Overview

GET

/v1/dashboard

Returns aggregate counts and plan details for the authenticated user: total domains, mailboxes (available/used/total), and current plan info.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Dashboard data fetched successfully

Bodyapplication/json

Example

{
    "status": 200,
    "message": "Dashboard data fetched successfully.",
    "data": {
        "totalDomains": 3,
        "mailboxes": {
            "available": 10,
            "used": 6,
            "total": 16
        },
        "plan": {
            "name": "Growth",
            "mailboxLimit": 25
        }
    }
}

🟠401

🔴500

Create Placement Test

Get Mailbox Status Counts