Felo API PlatformFelo API Platform

데이터 API / Apollo / People

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.

파라미터

쿼리

  • run_waterfall_emailboolean선택

    Set to true to enable email waterfall enrichment

  • run_waterfall_phoneboolean선택

    Set to true to enable phone waterfall enrichment

  • reveal_personal_emailsboolean선택

    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.

  • reveal_phone_numberboolean선택

    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.

  • webhook_urlstring선택

    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

요청 본문

  • detailsobject[]필수

    Provide info for each person you want to enrich as an object within this array. Add up to 10 people.

  • first_namestring선택

    First name, used with last_name. Example: tim

  • last_namestring선택

    Last name, used with first_name. Example: zheng

  • namestring선택

    Full name, e.g. "tim zheng"; replaces first_name + last_name.

  • emailstring선택

    Email address of the person.

  • hashed_emailstring선택

    MD5 or SHA-256 hash of the email address.

  • organization_namestring선택

    Name of the person's employer. Example: apollo

  • domainstring선택

    Domain of the person's employer, without www. Example: apollo.io

  • idstring선택

    Apollo person id, e.g. from a people search.

  • linkedin_urlstring선택

    LinkedIn profile URL of the person.

요청 예시

curl -X POST "https://openapi.felo.ai/v1/beta/apollo/people/bulk_match" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "details": [
    {}
  ]
}'

응답

응답 필드

  • statusstring선택

    Response field

  • error_codestring선택

    Response field

  • error_messagestring선택

    Response field

  • total_requested_enrichmentsinteger선택

    Response field

  • unique_enriched_recordsinteger선택

    Response field

  • missing_recordsinteger선택

    Response field

  • credits_consumedinteger선택

    Response field

  • matchesstring[]선택

    Response array

  • waterfallobject선택

    Response object