| Endpoint essentials | |
|---|---|
| API key access | api/v1/people/match or Master API key |
| OAuth scopes | people_match |
| Free account access | Requires an Apollo account registered with a work email address. Paid accounts aren't affected. |
| Credit usage | 1–9 credits per person without waterfall enrichment |
Credits are charged only if credit-consuming data is found: 1 credit for demographics or email, plus 8 credits if a mobile phone is returned. If no credit-consuming data is found, the request consumes 0 credits. Demographic credit usage depends on match_confidence. Apollo doesn't charge a demographic credit when match_confidence is none. Email and mobile phone credit usage isn't determined by match_confidence. Learn more about API pricing and credits.If waterfall enrichment is used for phone or email, credit usage depends on the returned data and the vendors included in your waterfall enrichment configuration; some vendors consume credits per lookup even when no data is found. | |
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. Check match_confidence in the response to understand how confidently Apollo matched the submitted information:
high: Apollo found a high-confidence match for the submitted person information.medium: Apollo identified a likely match with medium confidence.low: Apollo identified a possible match with low confidence.none: Apollo could not find a match for the submitted person information.
By default, this endpoint doesn't return personal emails or phone numbers. Use thereveal_personal_emailsandreveal_phone_numberparameters to retrieve emails and phone numbers.
When you usereveal_phone_number, a validwebhook_urlis 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 therun_waterfall_emailandrun_waterfall_phoneparameters 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 validwebhook_urlis 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.
Poll instead of a webhook
If you'd rather not register a webhook, set poll_only=true and omit webhook_url. Apollo returns a request_id you can pass to the poll webhook result endpoint to retrieve the result once it's ready.
Passing poll_only=true together with webhook_url returns a 400 error (WEBHOOK_URL_WITH_POLL_ONLY).
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.