Less boo. More booked. Halloween offer: 30 days free on any paid plan. Claim 30 days freeEvery new account gets one free mailbox for warmup and replies. No domain to buy. See how it works

Skip to content
Docs topic

API reference

The REST API for developers with an API key: accounts, campaigns, warmup, verification, leads, inbox, suppression, webhooks, workspaces, keys and usage.

12 articles114 min to read it all

01

Accounts

API reference for Warmerly accounts (mailboxes): connect Gmail, Outlook, or custom SMTP/IMAP inboxes and manage warmup status, ramp schedule, and…

16 min read
02

Campaigns

API reference for Warmerly campaigns: create and manage multi-step email and LinkedIn outbound sequences, their steps, sending accounts, and leads.

23 min read
03

Warmup

API reference for Warmerly warmup: pull mailbox health scores and the inbox-placement emails sent between accounts, to build dashboards or alert on…

8 min read
04

Verify

API reference for Warmerly's email verification: check syntax, MX records, disposable/role addresses, and live SMTP deliverability, single or in…

8 min read
05

Email Finder

API reference for the Warmerly Email Finder: find and verify a person's or company's email from a domain, website, or name, via async jobs you poll.

6 min read
06

Leads

API reference for the Warmerly lead database: search millions of crawled companies, export matching rows to CSV, and push them straight into a…

12 min read
07

Inbox

API reference for the Warmerly Inbox: list contacts, pull a unified email/LinkedIn conversation timeline, and send replies across channels.

11 min read
08

Suppression

API reference for the Warmerly suppression list: add addresses that must never be emailed in any campaign, and how addresses get on the list…

6 min read
09

Webhooks

API reference for Warmerly webhook subscriptions: get HTTP-signed notifications for mailbox health events like score drops, auto-pauses, and OAuth…

6 min read
10

Workspaces & Projects

API reference for Warmerly workspaces and projects: the tenant/billing hierarchy that mailboxes, campaigns, and inbox data attach to via X-Project-Id.

10 min read
11

API Keys

API reference for managing Warmerly API keys programmatically: create, list, and revoke keys used to authenticate requests to the Warmerly API.

3 min read
12

Usage & Limits

Read every monthly allowance and every plan limit for a Warmerly workspace over HTTP: GET /usage/quotas for the meters, GET /billing/me?limits=1 for…

5 min read

Not found what you need?

A person on the support team can look at your account. Use the chat button in the app, or write to us.