Skip to main content
GET
Get lead list API

Frequently asked questions

Poll this endpoint until status is ready. At that point actual_count holds the real row count, credits_charged holds what you paid, and can_preview and can_download both flip to true.
The estimate is a fast approximation; the actual count is what the query really matched. You are charged on the actual count, so a lower number costs you less.
They save you from encoding status rules on your side. Both are true only when the list is readyprocessing, failed and expired all yield false.

Authorizations

Authorization
string
header
required

API key in format tapi_live_[32-char] (live) or tapi_test_[32-char] (test)

Path Parameters

id
string<uuid>
required

The lead list id.

Example:

"f6ab2d94-c34f-47b7-9d1a-228e71488cd2"

Response

Lead list detail

success
boolean
Example:

true

data
object