In today’s digital age, accessing and manipulating data through APIs is a critical skill for developers. This blog post delves into an unofficial Apollo API, providing insights into its parameters and response structure. We’ll walk through a sample cURL request and explain each component to help you understand how to use this API effectively.

Sample cURL Request

Here’s the sample cURL request we’ll be dissecting:

Understanding the Parameters in our Apollo Api

1. numEmployees: Specifies the range of employee counts for the companies you’re interested in. Multiple ranges are separated by semicolons (;):
   • Example: 1,10;11,20;21,50 refers to companies with 1-10, 11-20, and 21-50 employees.
2. qKeywords: The keywords to search for in the job titles or descriptions.
   • Example: IT Jobs searches for jobs related to IT.
3. locations: The geographical location(s) to filter the search results.
   • Example: India filters the results to positions located in India.
4. apiKey: A unique key to authenticate your request. This ensures that only authorized users can access the API.
   • Example: mvOVpabt-9F7nMz5CTWKYSXWwWECp9FR.
5. personTitle: Specifies the job titles of individuals you’re looking for. Multiple titles are separated by semicolons (;):
   • Example: Human Resources Manager;HR Manager;HR Assistant searches for various HR roles.
6. industry: Filters the results by industry sectors. Multiple industries are separated by semicolons (;):
   • Example: computer software;information technology and services.
7. revenueRangeMin & revenueRangeMax: Sets the minimum and maximum revenue range of the companies you’re interested in.
   • Example: revenueRangeMin=100000&revenueRangeMax=1000000 searches for companies with revenues between $100,000 and $1,000,000.
8. next: Used for pagination to fetch the next set of results. Typically, this parameter will be empty for the first request.

Response Structure

The API returns a JSON response with detailed information. Here’s an example of what the response might look like:

Key Response Fields

1. next: A token to fetch the next set of results. Useful for pagination.
2. previous: Typically empty unless there’s a previous set of results.
3. total: The number of results in the current page.
4. totalLeads: The total number of leads available for the query.
5. approximateLeadCount: An estimate of the total leads based on the search criteria.
6. people: An array of objects, each representing a person that matches the search criteria.

Each person object includes:

• id: A unique identifier for the person.
• createdTime and updatedTime: Timestamps for when the record was created and last updated.
• firstName, lastName, name: Personal details.
• title: Job title.
• linkedinUrl: LinkedIn profile URL.
• state, city, country: Location details.
• organizationName: Name of the organization.
• organizationWebsiteUrl: URL of the organization’s website.
• organizationLinkedinUrl: LinkedIn URL of the organization.
• organizationTwitterUrl: Twitter URL of the organization.
• organizationFacebookUrl: Facebook URL of the organization.
• organizationPhone: Contact phone number of the organization.
• email: Email address (if available).
• organizationAbout: A brief description of the organization.

Detailed Explanation of Parameters

Let’s break down each parameter further to understand its significance and usage:

• numEmployees: This parameter allows you to target companies based on their size, which can be crucial for market segmentation and targeted marketing strategies. The employee ranges are defined as:
  • 1,10: Companies with 1 to 10 employees.
  • 11,20: Companies with 11 to 20 employees.
  • And so on. This granularity helps in pinpointing the exact segment of the market you’re interested in.
• qKeywords: This is used to specify the primary keywords you’re interested in. For instance, if you’re looking for IT jobs, entering IT Jobs ensures that the search results are relevant to this field.
• locations: Geographic filtering is essential for location-based targeting. By specifying India, the search results will only include entries from India. This is particularly useful for region-specific campaigns or research.
• apiKey: This is a security feature to ensure that only authorized users can access the API. It’s essential to keep your API key secure to prevent unauthorized access.
• personTitle: By specifying job titles, you can target individuals in specific roles. This is useful for HR professionals looking for potential candidates or sales teams targeting specific decision-makers. The semicolon-separated list allows for multiple job titles in one search.
• industry: Industry filtering helps in narrowing down the search to specific sectors. This is beneficial for B2B marketing, competitive analysis, or industry-specific research.
• revenueRangeMin & revenueRangeMax: These parameters are useful for financial segmentation. By setting a minimum and maximum revenue range, you can target companies within a specific financial bracket. This is useful for investment analysis, market segmentation, and targeting potential clients based on their revenue.
• next: This is used for pagination. When the results span multiple pages, the next token is used to fetch subsequent pages. This ensures that you can navigate through large datasets efficiently.

Example Scenarios

Here are a few scenarios where this API can be particularly useful:

1. HR Recruitment: An HR manager looking to fill IT positions in India can use the API to find potential candidates with relevant job titles and experience. They can filter by location, job titles, and company size to narrow down the search.
2. Market Research: A market research analyst can use the API to gather data on companies in the computer software and IT services industries. They can filter by employee size and revenue to understand market dynamics and identify potential growth areas.
3. Sales and Marketing: A sales team targeting HR departments in large companies can use the API to find contact information for HR managers and executives. They can filter by industry, location, and company size to tailor their outreach efforts.
4. Investment Analysis: An investment analyst can use the API to identify potential investment opportunities by filtering companies based on their revenue range and industry. This helps in finding companies that meet specific financial criteria.

Conclusion

The unofficial Apollo API is a powerful tool for retrieving detailed information about individuals and organizations based on various criteria. By understanding the parameters and response structure, you can tailor your API requests to fetch precise data, making your development process more efficient and effective. Whether you’re in HR, marketing, or any field that requires detailed lead information, mastering this API can significantly enhance your data retrieval capabilities. For a test, please contact us at matchkraft.com.