Skip to main content
POST
Import people-search results into an existing smart list.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

listId
string
required

Body

application/json
companyId
string
required

Company ID for access and any applicable data-credit charges

includeEmail
boolean
default:true

Enrich email for 1 data credit per person.

includePhone
boolean
default:false

Enrich mobile/direct phone for 2 data credits per returned number.

rows
object[]

Select 1–50 search results. Each needs linkedinUrl or email. Profile values must be text of at most 5000 characters (250000 for structured fields and long descriptions). Structured fields such as workHistory and educationHistory contain JSON in their own columns. Supported fields: workHistory, educationHistory, skills, certifications, locationDetails, companyLocationDetails, companyNaicsCodes, companyNaicsTitles, companyLinkedinIndustries, allEmails, nickname, salutation, profileUpdatedAt, companyEmployeeCount, externalId, displayName, firstName, lastName, email, businessEmail, personalEmail, phoneNumber, linkedinUrl, headline, location, positionTitle, positionLocation, seniority, department, companyName, companyWebsite, companyLinkedinUrl, companyEmployeeRange, companyIndustry, companyAnnualRevenue, businessEmailRiskScore, businessEmailValidatedAt, numOfConnections, about, photoUrl, companyDescription, companyFoundedOn, companyNumberOfFollowers, companyEmployeesOnLinkedin, companyLocation, summary, positionDescription, companyHeadquarters, companyCountry, companyType, companyKeywords, companyLogoUrl.

filters
object

Search filters, same shape as leads_searchPeopleDatabase. Required when rows are omitted.

count
integer

With filters: how many people to process, from 1 to 50000, starting at the first result. Required unless importAll is true.

importAll
boolean

With filters: process every match, capped at 50000.

audienceName
string

Optional label for the job.

importId
string

Optional UUID identifying this job. Reuse it to retrieve the same job when retrying an unchanged request.

Response

Queued import; poll lists_getTaskStatus with taskId

The queued background people job

taskId
string

Background task id. Poll lists_getTaskStatus with it until status is completed, failed or cancelled.

listId
string

The destination smart list (null for an export).

status
string

Always "background" — the job runs asynchronously.

message
string

Human-readable status message