Skip to main content

CI PyPI

qodev-apollo-cli

Agent-friendly CLI for the Apollo.io API. Designed for both human and AI-agent workflows, with structured JSON output, consistent flags, and predictable error codes.

Why this CLI?

  • Agent-friendly — --json on every command, consistent flags, predictable exit codes
  • Built for AI agent workflows — works seamlessly with Claude Code, scripts, and automation pipelines
  • Comprehensive — Access contacts, accounts, deals, enrichment, tasks, notes, and more
  • Dual output modes — Beautiful markdown tables for humans, structured JSON for agents

Installation

pip install qodev-apollo-cli

Or run directly without installing:

uvx qodev-apollo-cli

Quick Start

# Set your Apollo API key
export APOLLO_API_KEY="your_api_key_here"
# Install AI agent skill files (for Claude Code, etc.)
$ qodev-apollo-cli install --skills

# Search contacts
$ qodev-apollo-cli contacts search --query "engineer" --limit 5
Jane Smith     VP Engineering     Acme Corp     jane@acme.com

# Get contact details as JSON (for scripts/agents)
$ qodev-apollo-cli --json contacts get <contact-id>
{"id": "...", "name": "Jane Smith", "title": "VP Engineering", ...}

# Enrich a company (free)
$ qodev-apollo-cli enrich org acme.com

# Search deals in a specific stage
$ qodev-apollo-cli deals search --stage-id <stage-id>

# Check API usage
$ qodev-apollo-cli usage

Commands

Group Subcommand Description
contacts search Search contacts (--query, --stage-id, --stage-name, --linkedin-url)
get Get contact details by ID
create Create a new contact (--first-name, --last-name, --email, etc.)
update Update contact (--title, --label-ids)
upsert-by-linkedin Get or create a contact by LinkedIn URL (--name, --title, --stage-id)
stages List all contact stages
accounts search Search companies/accounts (--query, --domain)
get Get account details by ID
deals search Search opportunities/deals (--query, --stage-id, --stage-name)
get Get deal details by ID
role-types List opportunity contact role types
set-role Set/update a contact's role on a deal (--contact-id, --role-type, --primary)
pipelines list List all deal pipelines
get Get pipeline details
stages List stages in a pipeline
stages list List all contact stages
get Get stage details
enrich org Enrich organization by domain (FREE - no credits)
person Enrich person by email (1 credit per lookup)
people search Search people database (--titles, --seniorities, --locations, --organization-domains)
notes search Search notes (--contact-id, --account-id, --opportunity-id)
create Create a note (--contact-ids, --account-ids, --opportunity-ids, --content)
tasks search Search tasks (--type, --status)
create Create a task (--contact-ids, --note, --user-id, --due-at, --title)
connect Queue a LinkedIn connection request, no message by default (--contact-id, --note, --title)
calls search Search call activities
conversations search Search recorded conversations (--query)
get Get a conversation with transcript and AI summary
transcript Print just the transcript of a conversation
custom-fields list List custom field definitions (--modality)
emails search Search email activities
news search Search news (--categories)
jobs search Search job postings (--job-titles, --company-domains)
usage (default) Show API usage stats and rate limits
install --skills Install AI agent skill files to .claude/skills/apollo/

Configuration

Authentication

Set the APOLLO_API_KEY environment variable, or pass --api-key on each invocation:

export APOLLO_API_KEY="your_api_key_here"

Get your API key from Apollo.io Settings → API.

Global Options

Flag Description Default
--json Output as JSON (for scripting / agents) false
--api-key Apollo API key (overrides APOLLO_API_KEY)
--limit Results per page 25
--page Page number 1

Exit Codes

Code Meaning
0 Success
80 Authentication error (invalid API key)
81 Rate limit exceeded
82 API error (server error, invalid request)
83 Validation error (missing required fields)

JSON Output

All commands support --json for structured output:

qodev-apollo-cli --json contacts search --query "engineer" | jq '.items[0].name'

Paginated responses include:

{
  "items": [...],
  "total": 142,
  "page": 1,
  "limit": 25
}

Common Workflows

Find and enrich a contact

# Search by keyword
qodev-apollo-cli contacts search --query "jane smith"

# Get full details
qodev-apollo-cli contacts get <contact-id>

# Enrich person data (1 credit)
qodev-apollo-cli enrich person jane@example.com

Pipeline management

# List all pipelines
qodev-apollo-cli pipelines list

# Get stages in a pipeline
qodev-apollo-cli pipelines stages <pipeline-id>

# Search deals in specific stage
qodev-apollo-cli deals search --stage-id <stage-id>

LinkedIn integration

# Read-only lookup by LinkedIn URL (returns 0..n contacts, never writes)
qodev-apollo-cli contacts search --linkedin-url "https://linkedin.com/in/janesmith"

# Get or create a contact by LinkedIn URL (upsert); --name is required to create
qodev-apollo-cli contacts upsert-by-linkedin "https://linkedin.com/in/janesmith" --name "Jane Smith"

# Set title / stage when creating
qodev-apollo-cli contacts upsert-by-linkedin "https://linkedin.com/in/janesmith" \
  --name "Jane Smith" --title "VP Engineering" --stage-id <stage-id>

Company enrichment (FREE)

# Enrich by domain (no credits used)
qodev-apollo-cli enrich org acme.com

# View as JSON
qodev-apollo-cli --json enrich org acme.com | jq '.industry'

License

MIT -- see LICENSE for details.

Metadata

Release files for qodev-apollo-cli 1.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qodev-apollo-cli 1.5.0
File Size Uploaded
qodev_apollo_cli-1.5.0.tar.gz 70.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qodev-apollo-cli 1.5.0
File Interpreter ABI Platform
qodev_apollo_cli-1.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 115.2 kB

Release files / qodev_apollo_cli-1.5.0.tar.gz

Download URL qodev_apollo_cli-1.5.0.tar.gz
Size 70.8 kB
Tags Source
SHA-256 checksum
How to use checksums
41bbc81e51dc05c7009dfc419a1bdc0253fb647128821184614c3c4ee1b47960
BLAKE2b-256 checksum
How to use checksums
124391576a61232e40df67925ab4bdad0f3132d3b8d6c0e18201a40b91f7bebd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

Release files / qodev_apollo_cli-1.5.0-py3-none-any.whl

Download URL qodev_apollo_cli-1.5.0-py3-none-any.whl
Size 44.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b7d8a750629c138ebee882bedea5e14d291e5515673270c9734c37e7b7dd3d4
BLAKE2b-256 checksum
How to use checksums
bf066c634390efd3100368cdf84dd77c3641964e4022d2baffba2397248e39ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

Release history Release notifications | RSS feed

1.6.0

2 release files

1.5.1

2 release files

This release

1.5.0 This release

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page