Skip to content

Download List

GET
/lists/{audience_id}/download

Every row of a list as a CSV or XLSX file. FREE.

Unbounded: the file holds the WHOLE list. CSV comes back as text; XLSX as base64 in content with encoding: "base64".

Authorizations

Parameters

Path Parameters

audience_id
required
integer

Query Parameters

format

csv or xlsx.

string
default: xlsx
Allowed values: csv xlsx

csv or xlsx.

columns
Any of:
Array<string>

Only these columns. Omit for every column. LinkedIn profile URLs are always kept, as in the app.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A list’s rows as a file, inside the JSON envelope.

CSV comes back as text (encoding: "utf-8"). XLSX is binary, so it comes back base64-encoded (encoding: "base64"); decode it to get the workbook.

object
content
required
string
encoding
required
string
Allowed values: utf-8 base64
filename
required
string
format
required
string
Allowed values: csv xlsx
media_type
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string