Download List Data
Once the enrichment is complete, use this endpoint to retrieve your results.
Download List Data
POST /download_list
Headers
Content-Type
application/json
Body
api_key
string
Your API Key
listname
string
The name of your list to download.
limit
integer
Optional. Rows per page (minimum 1). Omit to download the full list.
offset
integer
Optional. Rows to skip before the page starts (minimum 0, default 0). Use with limit to read a large list in pages.
include_empty_columns
boolean
Optional, default false. Columns that are empty on every returned row are left out. Set true to get every column, empty or not.
Response
The contact rows are under data, and total is how many rows are in this response. See Response Format for the fields every endpoint returns.
Wait until Check List Status reports done before downloading, so you get the whole list.
Pages and empty columns
Only filled-in columns come back. A column is left out when it is empty on every row of the response, the same way the leads table hides it. A column with a value on any row is kept on every row, so all rows have the same keys. Empty means null, blank text, an empty list or an empty object. false and 0 are values and are kept. A missing column means no row in the response has a value for it. Send include_empty_columns: true to get every column.
Read a large list in pages. Send limit and offset. The first page is offset: 0, the next is offset: 500, then 1000, and so on. Rows come back in the same order on every call, so pages do not overlap. A page with fewer rows than limit is the last one.
Example
Last updated