Preview matching people
curl --request POST \
--url https://api.companyenrich.com/v2/people/search/preview \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"query": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"country": "<string>",
"position": "<string>",
"currentCompanyStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"currentPositionStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"education": {
"institutionLinkedinHandle": "<string>",
"institutionName": "<string>"
},
"pastExperience": {
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"position": "<string>",
"startDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"endDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
}
}
},
"semantic": {
"query": "<string>"
},
"company": {
"filter": {
"query": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"keywords": "<string>",
"technologies": "<string>",
"region": "<string>",
"country": "<string>",
"state": 123,
"city": 123,
"workforceGrowth": {
"min": 123,
"max": 123
},
"workforceSize": [
{
"min": 123,
"max": 123
}
],
"naicsCodes": "<string>",
"foundedYear": {
"min": 123,
"max": 123
},
"fundingAmount": {
"min": 123,
"max": 123
},
"fundingYear": {
"min": 123,
"max": 123
}
},
"semantic": {
"query": "<string>",
"weight": 0.5,
"autoFilter": true
},
"lookalike": {
"domains": [
"<string>"
],
"weight": 0,
"minScore": 0.5
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
query: '<string>',
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
domain: '<string>',
companyLinkedinHandle: '<string>',
country: '<string>',
position: '<string>',
currentCompanyStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
currentPositionStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
education: {institutionLinkedinHandle: '<string>', institutionName: '<string>'},
pastExperience: {
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
domain: '<string>',
companyLinkedinHandle: '<string>',
position: '<string>',
startDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
endDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'}
}
},
semantic: {query: '<string>'},
company: {
filter: {
query: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
domain: '<string>',
keywords: '<string>',
technologies: '<string>',
region: '<string>',
country: '<string>',
state: 123,
city: 123,
workforceGrowth: {min: 123, max: 123},
workforceSize: [{min: 123, max: 123}],
naicsCodes: '<string>',
foundedYear: {min: 123, max: 123},
fundingAmount: {min: 123, max: 123},
fundingYear: {min: 123, max: 123}
},
semantic: {query: '<string>', weight: 0.5, autoFilter: true},
lookalike: {domains: ['<string>'], weight: 0, minScore: 0.5}
}
})
};
fetch('https://api.companyenrich.com/v2/people/search/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.companyenrich.com/v2/people/search/preview"
payload = {
"filter": {
"query": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"country": "<string>",
"position": "<string>",
"currentCompanyStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"currentPositionStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"education": {
"institutionLinkedinHandle": "<string>",
"institutionName": "<string>"
},
"pastExperience": {
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"position": "<string>",
"startDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"endDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
}
}
},
"semantic": { "query": "<string>" },
"company": {
"filter": {
"query": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"keywords": "<string>",
"technologies": "<string>",
"region": "<string>",
"country": "<string>",
"state": 123,
"city": 123,
"workforceGrowth": {
"min": 123,
"max": 123
},
"workforceSize": [
{
"min": 123,
"max": 123
}
],
"naicsCodes": "<string>",
"foundedYear": {
"min": 123,
"max": 123
},
"fundingAmount": {
"min": 123,
"max": 123
},
"fundingYear": {
"min": 123,
"max": 123
}
},
"semantic": {
"query": "<string>",
"weight": 0.5,
"autoFilter": True
},
"lookalike": {
"domains": ["<string>"],
"weight": 0,
"minScore": 0.5
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"items": [
{
"id": 123,
"experiences": [
{
"isCurrent": true,
"position": "<string>",
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logoUrl": "<string>",
"industry": "<string>"
}
}
],
"name": "<string>",
"position": "<string>",
"department": "<string>"
}
],
"total": 123,
"interpretation": {
"companyNames": [
"<string>"
],
"filter": {
"query": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"seniority": "owner",
"department": "c-suite",
"country": "<string>",
"position": "<string>",
"currentCompanyStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"currentPositionStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"education": {
"institutionLinkedinHandle": "<string>",
"institutionName": "<string>"
},
"pastExperience": {
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"seniority": "owner",
"department": "c-suite",
"position": "<string>",
"startDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"endDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
}
}
},
"company": {
"query": "<string>",
"filter": {
"query": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"keywords": "<string>",
"technologies": "<string>",
"region": "<string>",
"country": "<string>",
"state": 123,
"city": 123,
"type": "private",
"employees": "1-10",
"reportedEmployees": "1-10",
"revenue": "under-1m",
"workforceGrowth": {
"period": "m6",
"department": "overall",
"min": 123,
"max": 123
},
"workforceSize": [
{
"department": "overall",
"min": 123,
"max": 123
}
],
"naicsCodes": "<string>",
"categories": "b2b",
"foundedYear": {
"min": 123,
"max": 123
},
"fundingRounds": "seed",
"fundingAmount": {
"min": 123,
"max": 123
},
"fundingYear": {
"min": 123,
"max": 123
},
"require": "linkedin"
},
"boost": {
"names": [
"<string>"
],
"categories": [
"b2b"
],
"revenue": [
"under-1m"
]
}
}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}People · Search
Preview matching people
Returns up to 10 person summaries using the same filters and ranking as search, without pagination or response expansions. Send an empty object ({}) to preview people without filters.
Requires a plan with people previews and does not consume credits.
POST
/
v2
/
people
/
search
/
preview
Preview matching people
curl --request POST \
--url https://api.companyenrich.com/v2/people/search/preview \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"query": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"country": "<string>",
"position": "<string>",
"currentCompanyStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"currentPositionStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"education": {
"institutionLinkedinHandle": "<string>",
"institutionName": "<string>"
},
"pastExperience": {
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"position": "<string>",
"startDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"endDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
}
}
},
"semantic": {
"query": "<string>"
},
"company": {
"filter": {
"query": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"keywords": "<string>",
"technologies": "<string>",
"region": "<string>",
"country": "<string>",
"state": 123,
"city": 123,
"workforceGrowth": {
"min": 123,
"max": 123
},
"workforceSize": [
{
"min": 123,
"max": 123
}
],
"naicsCodes": "<string>",
"foundedYear": {
"min": 123,
"max": 123
},
"fundingAmount": {
"min": 123,
"max": 123
},
"fundingYear": {
"min": 123,
"max": 123
}
},
"semantic": {
"query": "<string>",
"weight": 0.5,
"autoFilter": true
},
"lookalike": {
"domains": [
"<string>"
],
"weight": 0,
"minScore": 0.5
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
query: '<string>',
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
domain: '<string>',
companyLinkedinHandle: '<string>',
country: '<string>',
position: '<string>',
currentCompanyStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
currentPositionStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
education: {institutionLinkedinHandle: '<string>', institutionName: '<string>'},
pastExperience: {
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
domain: '<string>',
companyLinkedinHandle: '<string>',
position: '<string>',
startDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
endDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'}
}
},
semantic: {query: '<string>'},
company: {
filter: {
query: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
domain: '<string>',
keywords: '<string>',
technologies: '<string>',
region: '<string>',
country: '<string>',
state: 123,
city: 123,
workforceGrowth: {min: 123, max: 123},
workforceSize: [{min: 123, max: 123}],
naicsCodes: '<string>',
foundedYear: {min: 123, max: 123},
fundingAmount: {min: 123, max: 123},
fundingYear: {min: 123, max: 123}
},
semantic: {query: '<string>', weight: 0.5, autoFilter: true},
lookalike: {domains: ['<string>'], weight: 0, minScore: 0.5}
}
})
};
fetch('https://api.companyenrich.com/v2/people/search/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.companyenrich.com/v2/people/search/preview"
payload = {
"filter": {
"query": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"country": "<string>",
"position": "<string>",
"currentCompanyStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"currentPositionStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"education": {
"institutionLinkedinHandle": "<string>",
"institutionName": "<string>"
},
"pastExperience": {
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"position": "<string>",
"startDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"endDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
}
}
},
"semantic": { "query": "<string>" },
"company": {
"filter": {
"query": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"keywords": "<string>",
"technologies": "<string>",
"region": "<string>",
"country": "<string>",
"state": 123,
"city": 123,
"workforceGrowth": {
"min": 123,
"max": 123
},
"workforceSize": [
{
"min": 123,
"max": 123
}
],
"naicsCodes": "<string>",
"foundedYear": {
"min": 123,
"max": 123
},
"fundingAmount": {
"min": 123,
"max": 123
},
"fundingYear": {
"min": 123,
"max": 123
}
},
"semantic": {
"query": "<string>",
"weight": 0.5,
"autoFilter": True
},
"lookalike": {
"domains": ["<string>"],
"weight": 0,
"minScore": 0.5
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"items": [
{
"id": 123,
"experiences": [
{
"isCurrent": true,
"position": "<string>",
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logoUrl": "<string>",
"industry": "<string>"
}
}
],
"name": "<string>",
"position": "<string>",
"department": "<string>"
}
],
"total": 123,
"interpretation": {
"companyNames": [
"<string>"
],
"filter": {
"query": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"seniority": "owner",
"department": "c-suite",
"country": "<string>",
"position": "<string>",
"currentCompanyStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"currentPositionStartDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"education": {
"institutionLinkedinHandle": "<string>",
"institutionName": "<string>"
},
"pastExperience": {
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"companyLinkedinHandle": "<string>",
"seniority": "owner",
"department": "c-suite",
"position": "<string>",
"startDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
},
"endDate": {
"after": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z"
}
}
},
"company": {
"query": "<string>",
"filter": {
"query": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"keywords": "<string>",
"technologies": "<string>",
"region": "<string>",
"country": "<string>",
"state": 123,
"city": 123,
"type": "private",
"employees": "1-10",
"reportedEmployees": "1-10",
"revenue": "under-1m",
"workforceGrowth": {
"period": "m6",
"department": "overall",
"min": 123,
"max": 123
},
"workforceSize": [
{
"department": "overall",
"min": 123,
"max": 123
}
],
"naicsCodes": "<string>",
"categories": "b2b",
"foundedYear": {
"min": 123,
"max": 123
},
"fundingRounds": "seed",
"fundingAmount": {
"min": 123,
"max": 123
},
"fundingYear": {
"min": 123,
"max": 123
},
"require": "linkedin"
},
"boost": {
"names": [
"<string>"
],
"categories": [
"b2b"
],
"revenue": [
"under-1m"
]
}
}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
API Token used for authentication. Example: "Authorization: Bearer {token}"
Body
application/json
The filters to apply to the people search
Show child attributes
Show child attributes
The natural-language query used to infer person filters and the current companies
Show child attributes
Show child attributes
The company query used to find people whose current companies match
Show child attributes
Show child attributes
Response
OK