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

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

People Enrichment

​

Enrich one person: give whatever identifiers you have and get back Apollo's full record for them. Accepts email, first_name plus last_name, name, domain, organization_name, linkedin_url or hashed_email — the more you supply, the likelier the match. Returns a person object with id, name, title, headline, linkedin_url, twitter_url, github_url, photo_url, organization_id and an employment_history array, plus a request_id. Personal emails and phone numbers are withheld unless reveal_personal_emails or reveal_phone_number is set, and those cost extra credits. A 200 does not guarantee a match — check whether person actually came back. Use post_apollo_people_bulk_match for up to 10 people in one call; use post_apollo_mixed_people_api_search when you do not have an identifier and need to find candidates first. Requires Felo administrative permission.

Query Parameters
  • first_name
    Type: string

    The first name of the person. This is typically used in combination with the last_name parameter. Example: tim

  • last_name
    Type: string

    The last name of the person. This is typically used in combination with the first_name parameter. Example: zheng

  • name
    Type: string

    The full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the first_name and last_name parameters. Example: tim zheng

  • email
    Type: string

    The email address of the person. Example: [email protected]

  • hashed_email
    Type: string

    The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format. Example: 8d935115b9ff4489f2d1f9249503cadf (MD5) or 97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152 (SHA-256)

  • organization_name
    Type: string

    The name of the person's employer. This can be the current employer or a previous employer. Example: apollo

  • domain
    Type: string

    The domain name for the person's employer. This can be the current employer or a previous employer. Do not include www., the @ symbol, or similar. Example: apollo.io or microsoft.com

  • id
    Type: string

    The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID. To find IDs, call the People API Search endpoint and identify the values for person_id. Example: 587cf802f65125cad923a266

  • linkedin_url
    Type: string

    The URL for the person's LinkedIn profile. Example: http://www.linkedin.com/in/tim-zheng-677ba010

  • 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 the person's data 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 person's data 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 person's 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

Responses
  • 200
    Type: object

    Successful response

    • person
      Type: object

      Response object

    • 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/match
curl https://openapi.felo.ai/v1/beta/apollo/people/match \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "person": {},
  "waterfall": {}
}

Successful response

People Enrichment