WarmerlydocsGo to app →

Warmerly API

The Warmerly API lets you connect mailboxes, run email warmup, send campaigns, verify addresses, find emails, and manage your workspace programmatically — the same functionality available in the dashboard, exposed over HTTP.

Base URL

https://app.warmerly.com/api/v1

Quick example

curl https://app.warmerly.com/api/v1/accounts \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-Project-Id: 8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a"

See Authentication for how to get an API key and project ID, then jump into the resource you need:

  • Accounts — connect and manage mailboxes
  • Campaigns — outbound email/LinkedIn/WhatsApp sequences
  • Warmup — warmup health, stats, and trends
  • Verify — single and bulk email verification
  • Email Finder — find and enrich email addresses
  • Leads — search, export, and push leads from Warmerly's company database
  • Inbox — unified inbox, threads, and replies
  • Suppression — addresses that must never be sent to
  • Webhooks — subscribe to mailbox health events
  • Workspaces & Projects — multi-tenant workspace/project management
  • API Keys — create and revoke keys

Conventions

  • All request/response bodies are JSON.
  • Timestamps are ISO 8601 strings in UTC.
  • Resource IDs are UUIDs.
  • Errors return a JSON body of the shape { "error": { "code": "...", "message": "..." } } with a matching HTTP status code (400, 401, 403, 404, 409, 429, 500) — see Errors & Rate Limits for the full error-code table and every rate limit that applies.
  • See the API Changelog for what's changed and the deprecation policy.

What's not documented here

This API reference deliberately excludes:

  • Everything under /api/v1/admin/*. These routes back the internal Warmerly admin panel (workspace impersonation, billing overrides, platform-wide stats, support inbox, and similar). They require staff-only session auth, not an API key — they can't be called with the credentials this docs site describes — and exposing their shapes publicly would leak internal operational detail for no customer benefit.
  • Inbound provider webhooks (/api/v1/webhooks/resend-inbound, /api/v1/webhooks/unipile, /api/v1/webhooks/zernio). These receive signed callbacks from Warmerly's own infrastructure providers (inbound mail, LinkedIn/WhatsApp, Instagram/Facebook) — they're not something a customer integration calls or points anywhere. The customer-facing webhook feature is outbound subscriptions, where Warmerly calls a URL you provide.
  • OAuth callback routes (/api/v1/oauth/*, /api/v1/facebook/oauth, /api/v1/instagram/oauth, /api/v1/zernio/callback, and similar). These exist to complete browser-based OAuth redirect flows initiated from the dashboard; there's no way to drive them directly from an API integration.
  • Routes with no stable, versioned contract of their own — internal dashboard plumbing like /api/v1/dashboard/overview, /api/v1/onboarding/*, and /api/v1/tools/* are implementation details of the web app's own UI and may change shape without notice, unlike the endpoints documented in this reference.