Apollo Hello World

VerifiedSafe

Create a minimal working Apollo.io example. Use when starting a new Apollo integration or testing the API.

Sby Skills Guide Bot
DevelopmentBeginner
7/25/2026
Claude CodeCodex
#apollo-io#api-integration#quickstart#data-enrichment#typescript

Recommended for

Automated summary

Produces a minimal working Apollo.io API integration example covering people search, person enrichment, and organization enrichment, in both TypeScript and Python.

Strengths

  • Ships runnable code with the correct `x-api-key` header and the `api.apollo.io/api/v1` base URL
  • Clearly separates the free people-search endpoint (no emails or phones returned) from the enrichment endpoints that consume credits
  • Provides matching TypeScript and Python versions of the same operations
  • Demonstrates the three core calls — people search, people/match, organizations/enrich — and the fields each returns

Limitations

  • Assumes the API key is already set in `APOLLO_API_KEY` and that the `apollo-install-auth` step is complete
  • Does not cover HTTP error handling, rate limiting, or pagination beyond page one
  • The Python section is cut off in the source, so that snippet is incomplete
When to use it

Use it to bootstrap a new Apollo.io integration or to smoke-test that an API key and environment work end to end.

When not to use it

Avoid it as a production reference when you need robust error handling, pagination, credit budgeting, or webhook flows.

Security analysis

Safe
Quality score86/100

This is a documentation-style skill containing example code that calls the Apollo.io API using an API key read from the APOLLO_API_KEY environment variable. No destructive commands, shell execution (curl|sh), obfuscated payloads, credential exfiltration, or safety-disabling instructions are present. The declared tools (Read, Write, Edit) are appropriate for authoring example files, and the network calls are legitimate, intended API usage against api.apollo.io using the user's own credentials.

No concerns found

How this analysis is made

Examples

TypeScript quick start
Write a minimal TypeScript example that searches Apollo.io for senior engineers at apollo.io using the x-api-key header.
Enrich a person by email
Show me how to call Apollo's people/match endpoint to enrich a contact by email and print their title, company, and LinkedIn URL.
Organization lookup
Generate a Python script that enriches an organization by domain with Apollo's organizations/enrich endpoint and prints industry, headcount, and revenue.

name: apollo-hello-world description: | Create a minimal working Apollo.io example. Use when starting a new Apollo integration, testing your setup, or learning basic Apollo API patterns. Trigger with phrases like "apollo hello world", "apollo example", "apollo quick start", "simple apollo code", "test apollo api". allowed-tools: Read, Write, Edit version: 1.0.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io compatible-with: claude-code, codex, openclaw tags: [saas, apollo, api, testing]


Apollo Hello World

Overview

Minimal working example demonstrating the three core Apollo.io API operations: people search, person enrichment, and organization enrichment. Uses the correct x-api-key header and api.apollo.io/api/v1/ base URL.

Prerequisites

  • Completed apollo-install-auth setup
  • Valid API key configured in APOLLO_API_KEY environment variable

Instructions

Step 1: Search for People (No Credits Consumed)

The People API Search endpoint finds contacts in Apollo's 275M+ database. This endpoint is free — it does not consume enrichment credits, but it also does not return emails or phone numbers.

// hello-apollo.ts
import axios from 'axios';

const client = axios.create({
  baseURL: 'https://api.apollo.io/api/v1',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': process.env.APOLLO_API_KEY!,
  },
});

// People Search — POST /mixed_people/api_search
async function searchPeople() {
  const { data } = await client.post('/mixed_people/api_search', {
    q_organization_domains_list: ['apollo.io'],
    person_titles: ['engineer'],
    person_seniorities: ['senior', 'manager'],
    page: 1,
    per_page: 10,
  });

  console.log(`Found ${data.pagination.total_entries} contacts`);
  data.people.forEach((person: any) => {
    console.log(`  ${person.name} — ${person.title} at ${person.organization?.name}`);
  });
  return data;
}

searchPeople().catch(console.error);

Step 2: Enrich a Single Person (Consumes 1 Credit)

The People Enrichment endpoint returns full contact details including email and phone.

// Enrich by email, LinkedIn URL, or name+domain combo
async function enrichPerson() {
  const { data } = await client.post('/people/match', {
    email: 'tim@apollo.io',
    // Alternative identifiers:
    // linkedin_url: 'https://www.linkedin.com/in/...',
    // first_name: 'Tim', last_name: 'Zheng', organization_domain: 'apollo.io',
    reveal_personal_emails: false,
    reveal_phone_number: false,
  });

  if (!data.person) {
    console.log('No match found');
    return;
  }

  const p = data.person;
  console.log(`Name:     ${p.name}`);
  console.log(`Title:    ${p.title}`);
  console.log(`Email:    ${p.email}`);
  console.log(`Company:  ${p.organization?.name}`);
  console.log(`LinkedIn: ${p.linkedin_url}`);
}

Step 3: Enrich an Organization (Consumes 1 Credit)

// Organization Enrichment — GET /organizations/enrich
async function enrichOrg() {
  const { data } = await client.get('/organizations/enrich', {
    params: { domain: 'apollo.io' },
  });

  const org = data.organization;
  if (!org) { console.log('No org found'); return; }

  console.log(`Company:    ${org.name}`);
  console.log(`Industry:   ${org.industry}`);
  console.log(`Employees:  ${org.estimated_num_employees}`);
  console.log(`Revenue:    ${org.annual_revenue_printed}`);
  console.log(`HQ:         ${org.city}, ${org.state}, ${org.country}`);
  console.log(`Tech Stack: ${org.current_technologies?.slice(0, 5).map((t: any) => t.name).join(', ')}`);
}

Step 4: Python Equivalent

import os, requests

API_KEY = os.environ['APOLLO_API_KEY']
BASE = 'https://api.apollo.io/api/v1'
HEADERS = {'Content-Type': 'application/json', 'x-api-key': API_KEY}

# People search (free)
resp = requests.post(f'{BASE}/mixed_people/api_search', headers=HEADERS, json={
    'q_organization_domains_list': ['apollo.io'],
    'person_titles': ['engineer'],
    'page': 1, 'per_page': 5,
})
for p in resp.json().get('people', []):
    print(f"  {p['name']} — {p.get('title', 'N/A')}")

# Org enrichment (1 credit)
resp = requests.get(f'{BASE}/organizations/enrich',
    headers=HEADERS, params={'domain': 'apollo.io'})
org = resp.json().get('organization', {})
print(f"Company: {org.get('name')} ({org.get('estimated_num_employees')} employees)")

Output

  • People search results (name, title, company — no emails)
  • Enriched person with email, phone, LinkedIn URL
  • Enriched organization with industry, headcount, revenue, tech stack

Error Handling

| Error | Cause | Solution | |-------|-------|----------| | 401 Unauthorized | Missing or invalid x-api-key header | Check APOLLO_API_KEY env var | | 422 Unprocessable | Malformed request body | Verify JSON payload structure | | 429 Rate Limited | Exceeded requests/minute | Wait and retry with exponential backoff | | Empty people array | No matches for filters | Broaden titles/seniority or use different domain |

Resources

Next Steps

Proceed to apollo-local-dev-loop for development workflow setup.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/apollo-hello-world-mrzxuq3i' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/apollo-hello-world-mrzxuq3i/download' --output '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md.part' && mv '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md.part' '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Read, Write, Edit

Original excerpt: Prerequisites
  • Completed apollo-install-auth setup
  • Valid API key configured in APOLLO_API_KEY environment variable

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md' && test -s '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/apollo-hello-world' && cp -R '.skill-downloads/apollo-hello-world-mrzxuq3i' '.claude/skills/apollo-hello-world'

Codex
test -f '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md' && test -s '.skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/apollo-hello-world' && cp -R '.skill-downloads/apollo-hello-world-mrzxuq3i' '.agents/skills/apollo-hello-world'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/apollo-hello-world-mrzxuq3i'

openskills read 'apollo-hello-world-mrzxuq3i'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/apollo-hello-world-mrzxuq3i/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills