Pool

Preview pool matches

Runs a filter against the shared lead pool and returns the exact match count plus a small sample. Always run this before a build: the count it returns is the same number the build gates on, so it tells you in advance whether a build will be accepted and how many contacts it would create.

The filter is rejected outright if it is not selective enough to run quickly. The pool is over 100M rows, so an unbounded filter is not a slow query — it is one that must not start. A filter qualifies when it carries at least one of: v_category_in (preferred — verified from the company's own website), industry_exact, industry_pattern, p_bucket, sic_code_in, a keyword of 2+ characters, or state together with employees_min.

Geography is US-state-level. Use state (2-letter code) and city. There is no country filter — the pool has no country column, so passing one is rejected with a 400 rather than accepted and ignored.

A few filters the pool cannot honour (founded_year_min, founded_year_max, funding_stage_in, technology) are dropped rather than rejected. When that happens the response carries a warnings array naming them, so a count is never mistaken for a narrower one than it is.

post/v1/pool/search

Request

  • Base URL: https://api.automatedclientacquisition.com
  • URL: https://api.automatedclientacquisition.com/v1/pool/search
  • Auth: HTTP bearer

Request body

filterobject required

Pool filter. Must be selective enough to bound the scan.

limitinteger

How many sample rows to return alongside the count.

Response

Exact count plus a preview sample.

successboolean
totalinteger

Exact number of matches, not an estimate.

dataobject[]
preview_limitinteger
warningsstring[]

Present only when part of the filter was dropped. Names the filters the pool could not apply — total and data are NOT restricted by them.

Example response

{
  "success": true,
  "total": 4820,
  "preview_limit": 25
}

Changes

No recorded changes to this operation across all 1 revision of this API.