Export people as CSV
Returns as CSV the people GET /v1/people lists for the same filters, segmentId included. Each row is one person with handle, followers, email, website, company, location and tags, then outreach stage, owner and last contacted. The file holds at most 5,000 people. Each workspace can export 6 times a minute, and a 429 includes Retry-After.
Authorization
bearerAuth An API key from POST /v1/api-keys. Keys start with ref_.
In: header
Query Parameters
Only people with a profile on this platform.
Value in
- "bluesky"
- "hackernews"
- "github"
- "stackoverflow"
- "devto"
- "reddit"
- "x"
- "youtube"
- "news"
- "linkedin"
- "tiktok"
- "instagram"
- "appstore"
- "googleplay"
- "trustpilot"
- "googlemaps"
Searches the display name, handle and profile link, ignoring case.
1 <= length <= 200Looks up a person by one of their accounts, given as a handle (@sam, u/sam, sam) or a profile or post link (https://x.com/sam). The match is exact but ignores case, and covers merged accounts. Add platform to pick one platform. A link already tells which platform it is.
1 <= length <= 300Keeps people with this tag, matched exactly and by case.
1 <= length <= 40true keeps muted people and false people who are not muted. Leave it out for everyone.
A time in ISO 8601 or epoch ms. Keeps people first matched then or later.
date-timeAdds a saved segment's filter to all other filters here. An unknown id returns 404.
1 <= lengthKeeps people who have an account on one of these platforms. Repeat the parameter or separate values with commas.
items <= 20This many followers or more. People with an unknown count are left out.
0 <= valueKeeps people with this many followers or fewer.
0 <= valueMinimum number of matched mentions.
1 <= valueMinimum number of negative mentions.
1 <= valueHas a mention tagged with one of these intents.
items <= 10Leaves out people with an account on these platforms. Repeat the parameter or separate values with commas.
items <= 20Leaves out people whose mentions have one of these intents. Repeat the parameter or separate values with commas.
items <= 10Only people with a mention of these keyword kinds.
items <= 3Excludes people who mentioned these keyword kinds.
items <= 3People first seen in the past this many days.
1 <= value <= 365Keeps people with a mention that links to one of these hosts or its subdomains. Repeat the parameter or separate values with commas.
items <= 20Keeps people at one of these outreach stages. Repeat the parameter or separate values with commas.
items <= 6true keeps people whose matched posts are mostly machine-made, such as bots. false keeps the others. Leave it out for everyone.
Keeps people owned by one of these members, by user id. Use none for people without an owner. Repeat the parameter or separate values with commas.
items <= 20mentions puts the most matches first. recent puts the most recently seen first. reach puts the most followers first, with unknown counts at the end. new puts people seen for the first time most recently first.
"mentions"Value in
- "mentions"
- "recent"
- "reach"
- "new"
Response Body
text/csv
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/people/export.csv""string"