Apollo.io

reveal_personal_emails

Reveal personal emails of matched people. Consumes credits if set to true, respecting GDPR rules.

reveal_phone_number

Enrich data with phone numbers. Requires a webhook URL if true. Consumes credits.

webhook_url

Webhook URL to receive phone number details. Required if enriching with phone numbers.

details

Information of each person to enrich. Up to 10 people can be provided.

name

The name of the API key; provides context to its use

description

A description of the API key for additional context

scopes

List of Apollo API endpoints this key will be allowed to access. If omitted or empty, the key may not have endpoint access unless master_key is true.

master_key

Set to true to make the API key a master key, providing access to all endpoints available to your plan

api_key

Your Apollo API key for authentication. This is sent in the X-Api-Key header.

Name

The name for the API key providing context to its intended use.

Description

A detailed description of the API key to give additional context.

IsMasterKey

If true, the key will be set as a master key, granting access to all available endpoints.

email

The person's email address. Use this to look up a single person via email. Cannot be used together with name/domain.

first_name

The person's first name. When using name/domain lookup, provide first_name and last_name or name.

last_name

The person's last name. When using name/domain lookup, provide first_name and last_name or name.

name

The person's full name. Use as alternative to first_name and last_name.

domain

The person's employer's company domain. Required if using name-based lookup; ignored with email.

reveal_personal_emails

Set to true to reveal personal emails if available. Default is false.

reveal_phone_number

Set to true to reveal phone number if available. Default is false.

api_key

Your Apollo API key for authentication. Must be sent as 'X-Api-Key' header.

grant_type

The grant type for the token request. Must be 'authorization_code'.

code

The authorization code received from Apollo after the user authorized your app.

client_id

Your app's client ID, obtained after registering your application in the Apollo developer portal.

client_secret

Your app's client secret, obtained after registering your application in the Apollo developer portal.

redirect_uri

If specified, must be one of the redirect URIs registered on Apollo. Only needed when changing redirect URI.

grant_type

This must be 'authorization_code'

code

The authorization code received from the OAuth 2.0 server

client_id

Your app's client ID

client_secret

Your app's client secret

redirect_uri

Optional redirect URL

name

The display name of your integration that will appear in the Apollo Marketplace.

description

A brief overview of what your integration does for users.

website_url

The link to your product's website or the integration overview page.

integration_type

Category for your integration used for filtering in the Marketplace.

logo_url

A direct URL to the logo image that will be shown in Marketplace listing.

q_keywords

Keywords to narrow the search for contacts; can include names, job titles, employers, and email addresses.

contact_stage_ids[]

Apollo IDs for contact stages to filter search results. Contacts matching any of these stages will be included.

sort_by_field

The field to sort contacts by. Valid values: 'contact_last_activity_date', 'contact_email_last_opened_at', 'contact_email_last_clicked_at', 'contact_created_at', 'contact_updated_at'.

sort_ascending

If true, sorts the contacts in ascending order. Must be used together with 'sort_by_field'.

per_page

Number of results to return per page. Improves performance.

page

Page number to retrieve in the paginated results.

person_titles

Job titles to filter people by; a person needs to match at least one to appear in the results.

include_similar_titles

If true, returns people with similar job titles as well; if false, only strict matches on titles.

person_locations

Locations (cities, states, or countries) where people live; filters by this criteria.

person_seniorities

Job seniority level(s) to match against a person’s current job; only current level is considered.

organization_locations

Headquarters locations (city, state, or country) of employers to filter results by company location.

q_organization_domains_list

Employer domain(s) to filter people by current or past company; do not include 'www.' or '@'. Up to 1000 domains.

contact_email_status

Filter by the email status categories of the contacts.

organization_ids

Apollo IDs of the companies to include only those employers; ID must match those from Organization Search API.

organization_num_employees_ranges

Filters companies by employee headcount ranges. Each element should be a string of 'lower,upper' numbers, e.g., '100,500'.

q_keywords

A free text string to filter the results by keywords.

page

Zero-based page number to retrieve. Use with 'per_page' for paginated search.

per_page

Number of results per page. Used with 'page' to control pagination.

person_titles

Job titles held by the people you want to find. Examples include 'sales development representative', 'marketing manager', and 'research analyst'.

include_similar_titles

Whether to include people with job titles similar to those in 'person_titles'. Defaults to true.

person_locations

Locations where people live, such as cities, US states, or countries.

person_seniorities

Seniority levels within their current employer. Options include 'owner', 'founder', 'c_suite', etc.

organization_locations

Locations of the company headquarters for a person's current employer.

q_organization_domains_list

Domain names for the person's employer, e.g., 'apollo.io'.

contact_email_status

Email statuses to search for such as 'verified', 'unverified', etc.

organization_ids

Apollo IDs for specified companies.

organization_num_employees_ranges

Ranges of employee numbers in a given format, e.g., '1,10'.

q_keywords

A string of words for filtering the results.

page

Page number for pagination.

per_page

Number of results per page.

X-Api-Key

Your Apollo API key. Required for authentication and must be provided in the headers as 'X-Api-Key'.