Trulyinbox Open API

Introduction

Welcome to the Trulyinbox Open API documentation.

The Open API gives you programmatic access to manage email accounts, control warmup settings, monitor deliverability health scores, and pull warmup activity reports for email accounts belonging to your account.

Base URL

All API requests should be made to:

https://lupus-edge.trulyinbox.com/v1

Authentication

Every API request must include your API key in the X-Api-Key header.

Get Your API Key:

Log in to your TrulyInbox account
Navigate to Settings → API
Generate and copy your API Key

curl -X GET "https://lupus-edge.trulyinbox.com/v1/email-accounts" \
  -H "X-Api-Key: YOUR_API_KEY"

Security Note: Keep your API key secure. Never expose it in client-side code or public repositories.

Response Format

Error Response:

{
  "error_code": "not_found",
  "message": "Email account not found.",
  "details": {}
}

Rate Limiting

Each API key is limited to 20 requests per minute. Exceeding this limit will result in a 429 Too Many Requests response.

Every response includes rate limit headers:

Header	Description
`X-RateLimit-Limit`	Requests allowed per window (20 per API key)
`X-RateLimit-Remaining`	Requests remaining in current window
`X-RateLimit-Reset`	Unix timestamp when the window resets

Use GET /v1/rate-limit to check your current rate limit status without consuming quota.

What You Can Do

Email Accounts — Connect, disconnect, list, get status, bulk status, delete, and bulk delete email accounts
Warmup — Start/stop warmup, get and update warmup settings, bulk warmup actions, and view activity history
Deliverability — Get setup score, refresh setup score, and run DNS health checks
Reports — Single account reports, bulk reports, export reports, and account-wide dashboard
System — Health check and rate limit status