Developer REST APINEW

Developer REST API Build Email Intelligence Into Your Apps

REST endpoints for your deliverability overview, Domain Health, warmup (stats plus pause and resume), inbox placement tests, email analysis and connected mailboxes — authenticated with scoped API keys. Get started in minutes.

Go to Dashboard See pricing

Available on: Pro & Enterprise

api-example.ts

// Deliverability overview
const overview = await fetch(
  'https://api.inboxplease.com/api/v1/developer/overview',
  { headers: { 'X-API-Key': 'inp_...' } }
);

// Start an inbox placement test
const test = await fetch(
  'https://api.inboxplease.com/api/v1/developer/placement-tests',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'inp_...',
      'Content-Type': 'application/json',
      'Idempotency-Key': 'launch-1'
    },
    body: JSON.stringify({ mode: 'manual' })
  }
);
// -> seed_addresses + test_string: send your email to the seeds, then
//    GET /placement-tests/{test_id} for inbox / tabs / spam per provider.
// mode 'connected_mailbox' + sender_email sends from a connected mailbox instead.

Summary

What is Developer REST API?

The InboxPlease REST API covers six areas: a one-call deliverability overview with recommendations; Domain Health (monitored domains, latest results and scan history); warmup (senders, status, inbox rate, stats and session messages, plus pause and resume); inbox placement tests (start a manual or connected-mailbox test, then read inbox / tabs / spam per provider); email analysis of a raw email; and connected mailboxes with their connection status. Requests send an inp_ key in the X-API-Key header. Every scope is opt-in per feature and per mailbox, and each key is limited to 60 requests per minute. API access is included with Pro and Enterprise plans.

Style: REST over HTTPS, JSON
Base URL: api.inboxplease.com/api/v1/developer
Auth: X-API-Key header (inp_ keys)
Scopes: Opt-in per feature and per mailbox
Limits: 60 requests/min per key
Plans: Included with Pro (EUR 79/mo) and Enterprise

From key to first call

Three steps. A key can do nothing you didn't tick.

Step 01
Create a key and tick its scopes
In the dashboard, open Settings → API keys, create an inp_ key and tick only the scopes it needs. Optionally limit it to specific mailboxes.
Step 02
Call with X-API-Key
Send the key in the X-API-Key header to any endpoint under api.inboxplease.com/api/v1/developer. Plan and role are checked on every call.
Step 03
Poll results and act
Read the overview, Domain Health and placement results, then act: start placement tests or pause and resume warmup from an owner/admin key.

What the API gives you

Pay-per-request pricing is in development. In the meantime, all API access is included with Pro and Enterprise plans.

Scoped API keys

Every scope is opt-in per feature, and a key can be limited to specific mailboxes. Nothing is granted by default.

Placement tests by API

Start a test with manual seed addresses or from a connected mailbox. An Idempotency-Key header makes retries safe: the same request never starts a second test.

Warmup control

Read warmup status, inbox rate and per-sender stats, and pause or resume a sender's warmup.

One-call overview

GET /overview returns your deliverability overview with recommendations in a single request.

Owner/admin required for actions

Starting placement tests, pausing or resuming warmup and connecting mailboxes need a key created by an owner or admin.

Included with Pro

API access is included with Pro (EUR 79/mo) and Enterprise plans. No extra cost.

Endpoints

GET /whoamiKey identity, organization, plan and scopes

GET /overviewOne-call deliverability overview with recommendations

GET /domain-health/domainsMonitored domains with latest status

GET /domain-health/domains/{id}Latest complete result and latest attempt

GET /domain-health/domains/{id}/scansScan history, newest first

GET /warmupWarmup senders with status and inbox rate

GET /warmup/{sender}/statsStrategies and placement stats for one sender

GET /warmup/sessions/{id}/messagesMessages, threads and placement for one session

POST /warmup/{sender}/pause · /resumePause or resume a sender's warmup

POST /placement-testsStart an inbox placement test (manual or from a connected mailbox)

GET /placement-tests · /{id}List tests or get inbox / tabs / spam per provider

POST /email-analysisAuthentication, sending IP, hops and content verdicts for a raw email

GET /mailboxes · /{email}/statusConnected mailboxes and connection status

POST /mailboxes/connectOAuth link a person opens to connect a mailbox

Questions about Developer REST API

Which plans include the API?

Pro and Enterprise. The plan is checked on every call, so a downgrade removes access immediately. Free and expired trials have no API access.

How do scopes work?

Developer scopes are never granted by default: you tick each one when you create the key. Scopes are per feature (for example dev:warmup:read or dev:placement:run), and a key can also be limited to specific mailboxes so it only sees and acts on those addresses. Scopes that start tests, pause or resume warmup, or connect mailboxes only work on keys created by an owner or admin of the organization.

What are the rate limits?

60 requests per minute per key, with a maximum request body of 1 MB. Every call is recorded per key.

Can I run inbox placement tests through the API?

Yes. POST /placement-tests starts a test in manual mode, where you get seed addresses plus a unique test string and send the email yourself from any tool or ESP, or in connected mode, where InboxPlease sends from one of your connected mailboxes. GET /placement-tests/{id} returns inbox / tabs / spam / missing per provider; allow about 30 minutes for results to settle. Each test uses one of your plan's monthly scans when it starts (Pro 100/month, Enterprise unlimited), at most 5 manual tests can be waiting for results per 24 hours, and an Idempotency-Key header makes retries safe.