v1
latestOpenAPI 3.1.02026-07-247601.0 MBPeople Enrichment
This endpoint consumes 1-9 Apollo credits per person when credit-consuming data is found: 1 credit for demographics/email, plus 8 credits if a mobile phone is returned. If Apollo doesn't return credit-consuming data, the request consumes 0 credits.
If you use waterfall enrichment for phone or email, credit usage depends on the returned data and the vendors included in your waterfall enrichment configuration. Learn more about API pricing and credits.
<a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the People Enrichment endpoint to enrich data for one person. To enrich data for up to ten people with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment endpoint</a> instead.<br><br>Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a 200 response, but the response indicates that no records have been enriched.<br><br>By default, this endpoint doesn't return personal emails or phone numbers. Use the reveal_personal_emails and reveal_phone_number parameters to retrieve emails and phone numbers.<br><br>When you use reveal_phone_number, a valid webhook_url is required so Apollo can deliver the completed phone enrichment results. Apollo returns the main enrichment response synchronously, then sends the requested phone numbers to the webhook asynchronously. See webhook details.<br><br>You can also use the run_waterfall_email and run_waterfall_phone parameters to run waterfall enrichment via this endpoint. Waterfall enrichment gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers.<br><br>When you call this endpoint and include at least one waterfall parameter, a valid webhook_url is required so Apollo can deliver the completed waterfall enrichment results. Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo then delivers enriched emails or phone numbers asynchronously to the configured webhook.
Webhook Details
-
When using Apollo enrichment for phone number reveal, the webhook response follows: Native webhook response details.
-
When using waterfall enrichment, the webhook response follows: Waterfall webhook response details.
-
You can poll webhook results with the poll webhook result endpoint by passing <code>request_id</code>.
Webhook Requirements
-
HTTPS Required: Your endpoint must be publicly accessible over HTTPS.
-
Rate Limiting: Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo.
-
Idempotency: Apollo may retry webhook calls; your endpoint should be idempotent to handle duplicate payloads safely.
Query parameters
The first name of the person. This is typically used in combination with the last_name parameter. <br><br>Example: tim
The last name of the person. This is typically used in combination with the first_name parameter. <br><br>Example: zheng
The full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the first_name and last_name parameters. <br><br>Example: tim zheng
The email address of the person. <br><br>Example: example@email.com
The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format. <br><br>Example: 8d935115b9ff4489f2d1f9249503cadf (MD5) or 97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152 (SHA-256)
The name of the person's employer. This can be the current employer or a previous employer. <br><br>Example: apollo
The domain name for the person's employer. This can be the current employer or a previous employer. Do not include www., the @ symbol, or similar. <br><br>Example: apollo.io or microsoft.com
The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID. <br><br>To find IDs, call the <a href="https://docs.apollo.io/reference/people-api-search" target="_blank">People API Search endpoint</a> and identify the values for person_id. <br><br>Example: 587cf802f65125cad923a266
The URL for the person's LinkedIn profile. <br><br>Example: http://www.linkedin.com/in/tim-zheng-677ba010
Set to true to enable email waterfall enrichment
Set to true to enable phone waterfall enrichment
Set to true if you want to enrich the person's data with personal emails. This potentially consumes credits as part of your <a href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo pricing plan</a>. The default value is false. <br><br>If a person resides in a <a href="https://knowledge.apollo.io/hc/en-us/articles/4409141087757" target="_blank">GDPR</a>-compliant region, Apollo will not reveal their personal email.
Set to true if you want to enrich the person's data with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your <a href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo pricing plan</a>. The default value is false. <br><br>If this parameter is set to true, you must enter a webhook URL for the webhook_url parameter. Apollo will asynchronously verify phone numbers for you, then send a JSON response that includes only details about the person's phone numbers to the webhook URL you provide. It can take several minutes for the phone numbers to be delivered.
If you set the reveal_phone_number parameter to true, this parameter becomes mandatory. Otherwise, do not use this parameter. <br><br>Enter the webhook URL that specifies where Apollo should send a JSON response that includes the phone number you requested. Apollo suggests testing this flow to ensure you receive the separate response with the phone number. <br><br>If phone numbers are not revealed delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL. <br><br>Example: https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610; https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610
Response
200
Example response
{
"request_id": 1039995589705121900,
"person": {
"id": "64a7ff0cc4dfae00013df1a5",
"first_name": "Tim",
"last_name": "Zheng",
"name": "Tim Zheng",
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010",
"title": "Founder & CEO",
"email_status": "verified",
"photo_url": "https://static.licdn.com/aero-v1/sc/h/uzfsocwl05iywf1hd7ba3915x",
"headline": "Founder & CEO at Apollo",
"email": "tim@apollo.io",
"organization_id": "5e66b6381e05b4008c8331b8",
"employment_history": [
{
"_id": "66d7af8c200cad0001404c1f",
"current": true,
"organization_id": "5e66b6381e05b4008c8331b8",
"organization_name": "Apollo",
"start_date": "2016-01-01",
"title": "Founder & CEO",
"id": "66d7af8c200cad0001404c1f",
"key": "66d7af8c200cad0001404c1f"
}
],
"state": "California",
"city": "San Francisco",
"country": "United States",
"contact_id": "664fa05cf8299f0001f90876",
"contact": {
"id": "664fa05cf8299f0001f90876",
"first_name": "Roy",
"last_name": "Chung",
"name": "Roy Chung",
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010",
"title": "Reaching Peak Potential 💪⛰️📈🧪️ | President",
"contact_stage_id": "6095a710bd01d100a506d4ae",
"creator_id": "66302798d03b9601c7934ec2",
"person_id": "64a7ff0cc4dfae00013df1a5",
"organization_name": "Apollo.io",
"source": "crm",
"original_source": "crm",
"organization_id": "5e66b6381e05b4008c8331b8",
"headline": "Reaching Peak Potential 💪⛰️📈🧪️ | President at FRC",
"present_raw_address": "New York, New York, United States",
"created_at": "2024-05-23T20:00:28.527Z",
"email_status": "verified",
"account_id": "6658955877a2f20001c648ac",
"sanitized_phone": "+11235550158",
"updated_at": "2024-06-02T08:53:51.266Z",
"existence_level": "invisible",
"email": "roy@apollo.io",
"email_from_customer": true,
"email_true_status": "Verified",
"source_display_name": "Imported from CRM",
"contact_emails": [
{
"email": "roy@apollo.iorrr",
"email_md5": "879440a4afe6515e2de11dd7c531b770",
"email_sha256": "d445592892011f8539d5e92394929dfda7936867c21000b21788be8a46aa73d9",
"email_status": "verified"
}
],
"time_zone": "America/Los_Angeles",
"phone_numbers": [
{
"raw_number": "(123) 555-0158",
"sanitized_number": "+11235550158",
"status": "valid_number"
}
]
},
"revealed_for_current_team": true,
"organization": {
"id": "5e66b6381e05b4008c8331b8",
"name": "Apollo.io",
"website_url": "http://www.apollo.io",
"linkedin_url": "http://www.linkedin.com/company/apolloio",
"twitter_url": "https://twitter.com/meetapollo/",
"facebook_url": "https://www.facebook.com/MeetApollo",
"alexa_ranking": 3514,
"linkedin_uid": "18511550",
"founded_year": 2015,
"logo_url": "https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture",
"primary_domain": "apollo.io",
"industry": "information technology & services",
"keywords": [
"sales engagement"
],
"estimated_num_employees": 1600,
"industries": [
"information technology & services"
],
"snippets_loaded": true,
"industry_tag_id": "5567cd4773696439b10b0000",
"industry_tag_hash": {
"information technology & services": "5567cd4773696439b10b0000"
},
"raw_address": "415 Mission St, Floor 37, San Francisco, California 94105, US",
"street_address": "415 Mission St",
"city": "San Francisco",
"state": "California",
"postal_code": "94105-2301",
"country": "United States",
"seo_description": "Search, engage, and convert over 240 million contacts at over 30 million companies with Apollo's sales intelligence and engagement platform.",
"short_description": "Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round 🦄",
"annual_revenue_printed": "100M",
"annual_revenue": 100000000,
"total_funding": 251200000,
"total_funding_printed": "251.2M",
"latest_funding_round_date": "2023-08-01T00:00:00.000+00:00",
"latest_funding_stage": "Series D",
"funding_events": [
{
"id": "6574c1ff9b797d0001fdab1b",
"date": "2023-08-01T00:00:00.000+00:00",
"type": "Series D",
"investors": "Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners",
"amount": "100M",
"currency": "$"
}
],
"technology_names": [
"AI"
],
"current_technologies": [
{
"uid": "ai",
"name": "AI",
"category": "Other"
}
],
"org_chart_root_people_ids": [
"652fc57e2802bf00010c52f8"
],
"org_chart_sector": "OrgChart::SectorHierarchy::Rules::IT",
"org_chart_show_department_filter": true
},
"is_likely_to_engage": true,
"departments": [
"c_suite"
],
"subdepartments": [
"executive"
],
"functions": [
"entrepreneurship"
],
"seniority": "founder"
}
}