API reference
Account and usage
Your organisation's tier, limits and credits, usage, and the health check.
All requests go to https://api.padimail.app with Authorization: Bearer <your key>. Try these in the interactive reference with a pm_test_ key.
Health check (no key needed)
GET/v1/health
Example
import { PadiMail } from "@padimail/node";
const pm = new PadiMail(process.env.PADIMAIL_API_KEY);
const result = await pm.health();Response 200
{
"ok": true,
"service": "padimail-api",
"version": "string",
"time": "2026-10-27T13:05:09Z"
}Organisation, tier, plan, limits and credits
GET/v1/account
Example
import { PadiMail } from "@padimail/node";
const pm = new PadiMail(process.env.PADIMAIL_API_KEY);
const result = await pm.account.get();Response 200
{
"object": "account",
"id": "org_01JBX7Q3F6ZK0Q9W1Y2R3T4V5S",
"name": "string",
"tier": 0,
"status": "active",
"plan": "string",
"country": "string",
"timezone": "string",
"quota_behavior": "queue",
"limits": {
"daily_limit": 0,
"monthly_limit": 0,
"daily_used": 0,
"monthly_used": 0,
"daily_resets_at": "2026-10-27T13:05:09Z",
"monthly_resets_at": "2026-10-27T13:05:09Z",
"waiting": 0
},
"credits": { "emails": 0, "kobo": 0, "status": "none" }
}Emails sent, delivered, bounced, complained, opened and clicked
GET/v1/usage
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
from | string (date) | No | First day, YYYY-MM-DD. |
to | string (date) | No | Last day, YYYY-MM-DD. |
group_by | "day" | "stream" | No | day or stream. Default "day". |
Example
import { PadiMail } from "@padimail/node";
const pm = new PadiMail(process.env.PADIMAIL_API_KEY);
const result = await pm.account.usage({ from: "2026-10-01", to: "2026-10-31" });Response 200
{
"data": [
{
"day": "2026-10-27",
"stream": "transactional",
"emails_sent": 0,
"delivered": 0,
"bounced": 0,
"complained": 0,
"opened": 0,
"clicked": 0
}
]
}Was this page helpful?