Skip to main content
POST
Queue selected rows or a bounded filtered search into a company-owned 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; required when rows are omitted.

count
integer

Maximum people to process, from 1 to 50000.

importAll
boolean

Process matching results, capped at 50000.

importId
string

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

Response

Queued import; completion is emailed

The queued background people job

taskId
string

Background task id for the running import.

listId
string

The destination smart list.

status
string

Always "background" — the import runs asynchronously.

message
string

Human-readable status message