List mailboxes
Returns connected mailboxes, newest first, with cursor pagination. Soft-deleted mailboxes are excluded unless you filter by status=deleted. Each mailbox carries campaigns — the campaigns it sends for (id, name, status, channel; running first, up to 50) — and the exact campaign_count. Each mailbox also carries campaign_stats for the last stats_days days: campaign emails it sent and, of those, how many were opened, clicked or bounced (each email counted once — the same counting as the campaign pages), plus how many people it emailed replied. open_rate / click_rate are null when nothing with tracking on was sent (not measured, not 0%).
Required scope: mailboxes:read.
Returns a cursor-paginated list — pass cursor from the previous page to continue.
Request
- Base URL: https://warmysender.com/api/v1
- URL: https://warmysender.com/api/v1/mailboxes
- Auth: HTTP bearer
Query parameters
Results per page (1–100).
next_cursor from the previous page.
Exact-match filter on your external_id.
Case-insensitive substring match on the email address.
Filter by status.
Filter by warmup on/off.
Days covered by each mailbox's campaign_stats (1–365).
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.