Consumes CreditsThis 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.
Enrichment is when you refresh existing records so your prospecting data is up-to-date.
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 Bulk People Enrichment endpoint instead.
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.
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.
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.
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.
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 the
request_idfrom the people enrichment response.
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.