Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Bulk People Enrichment

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

Apollo

​

Person and company enrichment, people search, company job postings and news. Requires Felo administrative permission.

Apollo Operations

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.

Query Parameters
  • run_waterfall_email
    Type: boolean

    Set to true to enable email waterfall enrichment

  • run_waterfall_phone
    Type: boolean

    Set to true to enable phone waterfall enrichment

  • reveal_personal_emails
    Type: boolean

    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_number
    Type: boolean

    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_url
    Type: string

    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

Body
required
application/json
  • details
    Type: array object[]
    required

    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
      Type: string

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

    • email
      Type: string

      Email address of the person.

    • first_name
      Type: string

      First name, used with last_name. Example: tim

    • hashed_email
      Type: string

      MD5 or SHA-256 hash of the email address.

    • id
      Type: string

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

    • last_name
      Type: string

      Last name, used with first_name. Example: zheng

    • linkedin_url
      Type: string

      LinkedIn profile URL of the person.

    • name
      Type: string

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

    • organization_name
      Type: string

      Name of the person's employer. Example: apollo

Responses
  • 200
    Type: object

    Successful response

    • credits_consumed
      Type: integer

      Response field

    • error_code
      Type: string

      Response field

    • error_message
      Type: string

      Response field

    • matches
      Type: array string[]

      Response array

    • missing_records
      Type: integer

      Response field

    • status
      Type: string

      Response field

    • total_requested_enrichments
      Type: integer

      Response field

    • unique_enriched_records
      Type: integer

      Response field

    • waterfall
      Type: object

      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.

Request Example for post/v1/beta/apollo/people/bulk_match
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": {}
}

Successful response

Bulk People Enrichment