Built-in tool
Search People
Search for people by role, company and location, returning one page; or replenish a People List from its saved search.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| jobTitlesarray · optional | array | optional | Current job titles to match. Example: |
| jobTitlesExcludearray · optional | array | optional | Current job titles to leave out. Example: |
| seniorityLevelsarray · optional | array | optional | Seniority of the current role. One of: |
| jobFunctionsarray · optional | array | optional | Department of the current role. One of: |
| companiesListarray · optional | array | optional | Only people currently working at these companies, by company name. Matching is by name, so a common name can also match similarly named companies. Example: |
| industriesarray · optional | array | optional | LinkedIn industry names of the person's current company. Example: |
| companySizesarray · optional | array | optional | Employee-count bucket of the current company. One of: |
| companyKeywordsarray · optional | array | optional | Keywords matched against the current company's profile. Example: |
| countriesarray · optional | array | optional | Countries the person is in, as names or ISO-2 codes. Example: |
| citiesarray · optional | array | optional | Cities or regions the person is in. Example: |
| totalFundingMinnumber · optional | number | optional | Total funding the person's current company has raised, in USD. Example: |
| totalFundingMaxnumber · optional | number | optional | Total funding the person's current company has raised, in USD. Example: |
| lastFundingAmountMinnumber · optional | number | optional | Amount of the person's current company's most recent funding round, in USD. Example: |
| lastFundingAmountMaxnumber · optional | number | optional | Amount of the person's current company's most recent funding round, in USD. Example: |
| lastFundingYearMinnumber · optional | number | optional | Year of the person's current company's most recent funding round. Example: |
| lastFundingYearMaxnumber · optional | number | optional | Year of the person's current company's most recent funding round. Example: |
| lastFundingTypearray · optional | array | optional | Type of the person's current company's most recent funding round. One of: |
| lastFundingTypeExcludearray · optional | array | optional | Types of most recent funding round to leave out. One of: |
| investorsarray · optional | array | optional | Lead investors of the person's current company, by name. Example: |
| limitnumber · optional | number | optional | Maximum results to return in this run (1-50). Each result costs 0.1 credits; an empty page costs nothing. Default: |
| cursorstring · optional | string | optional | Resume token from a previous run's meta.cursor, to fetch the next page of the same search. Leave empty to start from the first page. |
| listIdstring · optional | string | optional | Replenish this People List from its saved search. Omit all filters and cursor. This changes Records and List membership. |
| targetNewnumber · optional | number | optional | With a saved People List, desired new members, no greater than the result limit. Duplicates and filtered profiles use that limit too. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"status",
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"title",
"headline",
"company",
"company_domain",
"company_linkedin_url",
"location",
"linkedin_url",
"summary",
"connections",
"skills",
"education",
"certifications",
"profile_photo_url"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"skills": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"headline": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"education": {
"type": [
"string",
"null"
]
},
"connections": {
"type": [
"number",
"null"
]
},
"linkedin_url": {
"type": [
"string",
"null"
]
},
"certifications": {
"type": [
"string",
"null"
]
},
"company_domain": {
"type": [
"string",
"null"
]
},
"profile_photo_url": {
"type": [
"string",
"null"
]
},
"company_linkedin_url": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"meta": {
"type": "object",
"required": [
"cursor",
"hasMore",
"returned",
"totalCount",
"actualCreditCost"
],
"properties": {
"cursor": {
"type": [
"string",
"null"
]
},
"hasMore": {
"type": "boolean"
},
"returned": {
"type": "number"
},
"listImport": {
"type": "string"
},
"totalCount": {
"type": [
"number",
"null"
]
},
"actualCreditCost": {
"type": "number"
}
},
"additionalProperties": false
},
"status": {
"type": "string",
"const": "ok"
},
"replenishment": {
"type": "object",
"required": [
"added",
"recordIds",
"addedRecordIds",
"exhausted",
"slicesRemaining",
"needsNarrowing",
"stalled",
"budgetLimited",
"stopReason",
"returned",
"pages",
"httpAttempts",
"listId"
],
"properties": {
"added": {
"type": "integer",
"minimum": 0
},
"pages": {
"type": "integer",
"maximum": 16,
"minimum": 0
},
"listId": {
"type": "string",
"format": "uuid"
},
"stalled": {
"type": "boolean"
},
"returned": {
"type": "integer",
"maximum": 50,
"minimum": 0
},
"exhausted": {
"type": "boolean"
},
"recordIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 50
},
"stopReason": {
"enum": [
"target",
"exhausted",
"budget",
"deadline",
"needs_narrowing",
"stalled",
"failure"
],
"type": "string"
},
"httpAttempts": {
"type": "integer",
"maximum": 8,
"minimum": 0
},
"budgetLimited": {
"type": "boolean"
},
"addedRecordIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 50
},
"needsNarrowing": {
"type": "boolean"
},
"slicesRemaining": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}