You can retrieve a list of all CSVs that have been uploaded along with their current state using this API. If you want to download any of the results of a CSV you'll need to use the status API to fetch a list of all available downloads for a CSV. Please call the URL below to retrieve a list of CSVs. Results will be delivered at 50 per page, with the most recent upload displayed first. Optional parameters are listed at the bottom of this page.
This API will return responses that will contain your API key. Treat these responses like passwords and do not share them with third parties.
|Optional GET / POST / URL Parameters|
|type||The type of CSVs to list. (proxy, email, url or phone)|
|page||The page number of results to return. Each page lists 50 CSVs in order of most recently uploaded.|
An example success/failure response is included below.
When you retrieve the list the result should look like the JSON below. For detailed information on each field see the table at the bottom of this page.
Note: You can check the status URL provided to get the current processing status of the CSV. The list API does not return download links for the CSVs displayed. You must query the status URL to get the download link(s). The remainder of the fields are documented on the bulk CSV API processing status documentation.
If you specify a wrong type or wrong page, then an error will trigger such as:
|message||Messages about the status of your request to include potential errors.||string|
|success||True if this request was successful, false if unsuccessful.||boolean|
An array/list of CSVs you've requested to be processed by our system. Values for each object in this array are below.