Skip to content
Docs

Get Warmup Pool

List the workspace's email accounts with warmup progress and pool activity.

GEThttps://api.foxreach.io/api/v1/warmup/pool

Requires an API key with the read scope.

Returns every email account in the workspace, not only the ones with warmup on; check warmupEnabled on each entry. Pass tag to narrow it to accounts carrying one warmup tag.

Query Parameters#

tagstringquery

A warmup tag id from List Warmup Tags. Only accounts with that tag are returned. An id that is not a warmup tag of this workspace returns an empty list.

Response#

dataarray

One entry per account.

Show data
accountIdstring
Email account identifier.
emailstring
Mailbox address.
displayNamestring
Friendly name, or null.
healthScoreinteger
The Health Score: share of warmup email that landed in the inbox over the last 7 days, 0 to 100. null until enough emails have been measured.
healthBasisobject
Counts behind the score: window, inbox, spam, verified, minVerified, state (measured, building or off), score, weighted.
warmupEnabledboolean
Whether warmup is on.
warmupProgressobject
enabled, progress (percent), daysCompleted, totalDays, currentLimit, targetLimit.
poolStatsobject
sentCount, receivedCount, replyCount.
tagsarray
Warmup tags on the account: id, name, color.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: read

Rate Limit#

  • 100 requests per minute, per API key. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 2, 2026