Apollo
Person and company enrichment, people search, company job postings and news. Requires Felo administrative permission.
Bulk People Enrichment
Enrich up to 10 people in one call. Body takes details, an array of the same identifier objects post_apollo_people_match accepts. Returns matches alongside status, total_requested_enrichments, unique_enriched_records, missing_records and credits_consumed — read missing_records rather than assuming every input matched. Costs one credit per record enriched, not per call. Use this over a loop of single calls: same credits, one round trip. For a single person post_apollo_people_match is simpler. Requires Felo administrative permission.
- 型: booleanrun
_waterfall _email Set to true to enable email waterfall enrichment
- 型: booleanrun
_waterfall _phone Set to true to enable phone waterfall enrichment
- 型: booleanreveal
_personal _emails Set to true if you want to enrich all matched people with personal emails. This potentially consumes credits as part of your Apollo pricing plan . The default value is false. If a person resides in a GDPR -compliant region, Apollo will not reveal their personal email.
- 型: booleanreveal
_phone _number Set to true if you want to enrich the data of all matched people with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your Apollo pricing plan . The default value is false. 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 phone numbers to the webhook URL you provide. It can take several minutes for the phone numbers to be delivered.
- 型: stringwebhook
_url If you set the reveal_phone_number parameter to true, this parameter becomes mandatory. Otherwise, do not use this parameter. 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. If phone numbers are not revealed delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL. Example: https://webhook.site/cc4cf44e-e047-4774-8dac-473d28474e40; https%3A%2F%2Fwebhook.site%2Fcc4cf44e-e047-4774-8dac-473d28474e40
- 型: array object[]details必須
Provide info for each person you want to enrich as an object within this array. Add up to 10 people.
One person to enrich. Give whatever identifiers you have — the more, the likelier the match.
- domain型: string
Domain of the person's employer, without www. Example: apollo.io
- email型: string
Email address of the person.
- first型: string
_name First name, used with last_name. Example: tim
- hashed型: string
_email MD5 or SHA-256 hash of the email address.
- id型: string
Apollo person id, e.g. from a people search.
- last型: string
_name Last name, used with first_name. Example: zheng
- linkedin型: string
_url LinkedIn profile URL of the person.
- name型: string
Full name, e.g. "tim zheng"; replaces first_name + last_name.
- organization型: string
_name Name of the person's employer. Example: apollo
- 型: object200
Successful response
- 型: integercredits
_consumed Response field
- 型: stringerror
_code Response field
- 型: stringerror
_message Response field
- 型: array string[]matches
Response array
- 型: integermissing
_records Response field
- 型: stringstatus
Response field
- 型: integertotal
_requested _enrichments Response field
- 型: integerunique
_enriched _records Response field
- 型: objectwaterfall
Response object
application/json - 400
Bad request
- 401
Unauthorized
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
Rate limit exceeded
- 500
Internal server error
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/apollo/people/bulk_match \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"details": [
{
"first_name": "",
"last_name": "",
"name": "",
"email": "",
"hashed_email": "",
"organization_name": "",
"domain": "",
"id": "",
"linkedin_url": ""
}
]
}'
{
"status": "string",
"error_code": "string",
"error_message": "string",
"total_requested_enrichments": 1,
"unique_enriched_records": 1,
"missing_records": 1,
"credits_consumed": 1,
"matches": [
"string"
],
"waterfall": {}
}