Retrieve enrichment results
Retrieves the results of an asynchronous person enrichment operation
curl --request GET \
--url https://api.customeros.ai/enrich/v1/person/results/{id} \
--header 'X-CUSTOMER-OS-API-KEY: <api-key>'{
"data": {
"emails": [
{
"address": "john.doe@example.com",
"deliverable": "true",
"isRisky": false,
"type": "work"
}
],
"jobs": [
{
"company": "Tech Corp",
"companyLinkedin": "https://linkedin.com/company/techcorp",
"companyWebsite": "https://techcorp.com",
"duration": {
"endMonth": 12,
"endYear": 2023,
"startMonth": 1,
"startYear": 2020
},
"isCurrent": true,
"seniority": "Senior",
"title": "Software Engineer"
}
],
"location": {
"city": "San Francisco",
"country": "United States",
"region": "California",
"timezone": "PST"
},
"name": {
"firstName": "John",
"fullName": "John Doe",
"lastName": "Doe"
},
"phoneNumbers": [
{
"number": "+14155552671",
"type": "mobile"
}
],
"profilePic": "https://example.com/profile.jpg",
"social": {
"discord": {
"username": "johndoe#1234"
},
"github": {
"url": "https://github.com/johndoe",
"username": "johndoe"
},
"linkedin": {
"followerCount": 500,
"id": "123456789",
"publicId": "john-doe",
"url": "https://linkedin.com/in/john-doe"
},
"x": {
"handle": "johndoe",
"url": "https://x.com/johndoe"
}
}
},
"isComplete": true,
"message": "Enrichment completed",
"pendingFields": [
"email",
"phone number"
],
"resultUrl": "https://api.customeros.ai/enrich/v1/person/results/550e8400-e29b-41d4-a716-446655440000",
"status": "success"
}Authorizations
Path Parameters
Result ID
Response
Response structure for person enrichment operations
Enriched person data required: true
List of email addresses associated with the person required: false
Email address with validation details
Email address required: true format: email
"john.doe@example.com"
Indicates if the email is deliverable required: false
"true"
Indicates if the email is considered risky required: false
false
Type of email address required: false enum: personal,work
"work"
Employment history required: false
Details about a person's job position
Company name required: true
"Tech Corp"
Company's LinkedIn URL required: false format: uri
"https://linkedin.com/company/techcorp"
Company's website required: false format: uri
"https://techcorp.com"
Employment duration required: true
Ending month (1-12) required: false minimum: 1 maximum: 12
12
Ending year required: false minimum: 1900 maximum: 2100
2023
Starting month (1-12) required: false minimum: 1 maximum: 12
1
Starting year required: false minimum: 1900 maximum: 2100
2020
Indicates if this is the current position required: true
true
Seniority level required: false enum: Junior,Mid-Level,Senior,Lead,Manager,Director,VP,C-Level
"Senior"
Job title required: true
"Software Engineer"
Geographic location information required: false
City name required: false
"San Francisco"
Country name required: false
"United States"
State or region required: false
"California"
Timezone identifier required: false example: America/Los_Angeles
"PST"
Person's name information required: true
List of phone numbers required: false
Phone number with type classification
URL to person's profile picture required: false format: uri
"https://example.com/profile.jpg"
Social media presence required: false
Discord profile information required: false
Discord username with discriminator required: true pattern: ^.{3,32}#[0-9]{4}$
"johndoe#1234"
LinkedIn profile information required: false
Number of LinkedIn followers required: false minimum: 0
500
LinkedIn internal ID required: false
"123456789"
LinkedIn public identifier required: false
"john-doe"
Full LinkedIn profile URL required: false format: uri
"https://linkedin.com/in/john-doe"
Indicates if all enrichment operations are complete required: true
true
Optional message providing additional information required: false
"Enrichment completed"
List of fields still being processed required: false
["email", "phone number"]
URL to check the final result when processing is incomplete required: false format: uri
"https://api.customeros.ai/enrich/v1/person/results/550e8400-e29b-41d4-a716-446655440000"
Operation status required: true enum: success,error,warning
"success"
curl --request GET \
--url https://api.customeros.ai/enrich/v1/person/results/{id} \
--header 'X-CUSTOMER-OS-API-KEY: <api-key>'{
"data": {
"emails": [
{
"address": "john.doe@example.com",
"deliverable": "true",
"isRisky": false,
"type": "work"
}
],
"jobs": [
{
"company": "Tech Corp",
"companyLinkedin": "https://linkedin.com/company/techcorp",
"companyWebsite": "https://techcorp.com",
"duration": {
"endMonth": 12,
"endYear": 2023,
"startMonth": 1,
"startYear": 2020
},
"isCurrent": true,
"seniority": "Senior",
"title": "Software Engineer"
}
],
"location": {
"city": "San Francisco",
"country": "United States",
"region": "California",
"timezone": "PST"
},
"name": {
"firstName": "John",
"fullName": "John Doe",
"lastName": "Doe"
},
"phoneNumbers": [
{
"number": "+14155552671",
"type": "mobile"
}
],
"profilePic": "https://example.com/profile.jpg",
"social": {
"discord": {
"username": "johndoe#1234"
},
"github": {
"url": "https://github.com/johndoe",
"username": "johndoe"
},
"linkedin": {
"followerCount": 500,
"id": "123456789",
"publicId": "john-doe",
"url": "https://linkedin.com/in/john-doe"
},
"x": {
"handle": "johndoe",
"url": "https://x.com/johndoe"
}
}
},
"isComplete": true,
"message": "Enrichment completed",
"pendingFields": [
"email",
"phone number"
],
"resultUrl": "https://api.customeros.ai/enrich/v1/person/results/550e8400-e29b-41d4-a716-446655440000",
"status": "success"
}