Crm

Apollo

Learn how to use Apollo with Composio

Overview

SLUG: APOLLO

Description

Apollo provides CRM and lead generation capabilities, helping businesses discover contacts, manage outreach, and track sales pipelines for consistent customer relationship development

Authentication Details

generic_api_key
stringRequired

Connecting to Apollo

Create an auth config

Use the dashboard to create an auth config for the Apollo toolkit. This allows you to connect multiple Apollo accounts to Composio for agents to use.

1

Select App

Navigate to Apollo.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Apollo Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4apollo_auth_config_id = "ac_YOUR_APOLLO_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Apollo for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, apollo_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Apollo toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["APOLLO"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Contacts to Sequence

Description

Adds contacts to a specified apollo email sequence by initiating an asynchronous background job and returning its details.

Action Parameters

contact_ids
arrayRequired
emailer_campaign_id
stringRequired
send_email_from_email_account_id
stringRequired
sequence_active_in_other_campaigns
boolean
sequence_finished_in_other_campaigns
boolean
sequence_id
stringRequired
sequence_job_change
boolean
sequence_no_email
boolean
sequence_unverified_email
boolean
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Bulk organization enrichment

Description

Enriches data for up to 10 organizations simultaneously by providing a list of their base company domains (e.g., 'apollo.io', not 'www.apollo.io').

Action Parameters

domains
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Bulk people enrichment

Description

Use to enrich multiple person profiles simultaneously with comprehensive data from apollo's database.

Action Parameters

details
arrayRequired
reveal_personal_emails
boolean
reveal_phone_number
boolean
webhook_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Bulk update account stage

Description

Bulk updates the stage for specified existing apollo.io accounts, moving them to a valid new account stage.

Action Parameters

account_ids
arrayRequired
account_stage_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Labels

Description

Retrieves all labels from apollo.io, used for organizing contacts and accounts.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get opportunity stages

Description

Retrieves all configured opportunity (deal) stages from the apollo.io account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Organization Job Postings

Description

Retrieves paginated job postings for a specified organization by its id, optionally filtering by domain; ensure `organization id` is a valid identifier.

Action Parameters

organization_id
stringRequired
page
integer
per_page
integer
q_organization_domains
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get typed custom fields

Description

Retrieves all typed custom field definitions available in the apollo.io instance, detailing their types and configurations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List email accounts

Description

Retrieves all email accounts and their details for the authenticated user; takes no parameters.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search sequences

Description

Searches for sequences (e.g., automated email campaigns) in apollo.io.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 25
q_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search tasks

Description

Searches for tasks in apollo.io using filters like keywords, date ranges (due, created, updated), priorities, types, assigned users, associated contacts/accounts, supporting sorting and pagination.

Action Parameters

account_ids
array
contact_ids
array
due_date_range
object
page
integer
per_page
integer
q_keywords
string
sort_ascending
boolean
sort_by_field
string
task_created_at_range
object
task_priorities
array
task_types
array
task_updated_at_range
object
task_user_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update contact ownership

Description

Updates the ownership of specified apollo contacts to a given apollo user, who must be part of the same team.

Action Parameters

contact_ids
arrayRequired
owner_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update contact stage

Description

Updates the stage for one or more existing contacts in apollo.io to a new valid contact stage, useful for managing sales funnel progression.

Action Parameters

contact_ids
arrayRequired
contact_stage_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update contact status in sequence

Description

Updates a contact's status within a designated apollo sequence, but cannot set the status to 'active'.

Action Parameters

contact_id
stringRequired
sequence_id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create an Apollo account

Description

Creates a new account in apollo.io; a new record is created even if a similar account exists, and provided `owner id` or `account stage id` must be valid existing ids.

Action Parameters

account_stage_id
string
domain
string
name
stringRequired
owner_id
string
phone
string
raw_address
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Apollo contact

Description

Creates a new contact in apollo.io; use `account id` to link to an organization and `contact stage id` for sales stage, noting that apollo does not perform automatic deduplication.

Action Parameters

account_id
string
contact_stage_id
string
corporate_phone
string
direct_phone
string
email
string
first_name
stringRequired
home_phone
string
label_names
array
last_name
stringRequired
mobile_phone
string
organization_name
string
other_phone
string
present_raw_address
string
title
string
website_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Apollo deal

Description

Creates a new sales opportunity (deal) in apollo.io; all provided ids (`owner id`, `account id`, `opportunity stage id`) must be valid existing apollo identifiers.

Action Parameters

account_id
string
amount
string
closed_date
string
name
stringRequired
opportunity_stage_id
string
owner_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Apollo Task

Description

Creates a distinct apollo.io task for each contact id in contact ids, assigning them to user id; this action is not for free plan users and repeated calls create duplicate tasks.

Action Parameters

contact_ids
arrayRequired
due_at
stringRequired
note
string
priority
stringRequired
status
stringRequired
type
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Apollo account stages

Description

Retrieves all available apollo.io account stages, each including its unique id and name.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List apollo contact stages

Description

Retrieves all available contact stages from an apollo account, including their unique ids and names.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Apollo deals

Description

Retrieves a list of deals from apollo, using apollo's default sort order if 'sort by field' is omitted.

Action Parameters

page
integer
per_page
integer
sort_by_field
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Apollo Users

Description

Retrieves a list of all users (teammates) associated with the apollo account, supporting pagination via `page` and `per page` parameters.

Action Parameters

page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Enrich organization data

Description

Fetches comprehensive organization enrichment data from apollo.io for a given company domain; results are most meaningful if the company exists in apollo's database.

Action Parameters

domain
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Enrich person with Apollo

Description

Enriches and retrieves information for a person from apollo.io, requiring one of: `email`, `hashed email`, `id`, `linkedin url`, or (`first name` and `last name` with `organization name` or `domain`) for matching; `webhook url` must be provided if `reveal phone number` is true.

Action Parameters

domain
string
email
string
first_name
string
hashed_email
string
id
string
last_name
string
linkedin_url
string
name
string
organization_name
string
reveal_personal_emails
boolean
reveal_phone_number
boolean
webhook_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Apollo Accounts

Description

Searches for accounts within your existing apollo.io database using various criteria; requires a paid plan and is limited to 50,000 records.

Action Parameters

account_stage_ids
array
page
integer
per_page
integer
q_organization_name
string
sort_ascending
boolean
sort_by_field
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Apollo contacts

Description

Searches apollo contacts using keywords, stage ids (from 'list contact stages' action), or sorting (max 50,000 records; `sort ascending` requires `sort by field`).

Action Parameters

contact_stage_ids
array
page
integer
per_page
integer
q_keywords
string
sort_ascending
boolean
sort_by_field
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update an Apollo account

Description

Updates specified attributes of an existing account in apollo.io.

Action Parameters

account_id
stringRequired
account_stage_id
string
domain
string
name
string
owner_id
string
phone
string
raw_address
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Apollo contact

Description

Updates specified attributes of an existing apollo.io contact, identified by `contact id`; requires at least one other attribute to be provided for modification.

Action Parameters

account_id
string
contact_id
stringRequired
contact_stage_id
string
corporate_phone
string
direct_phone
string
email
string
first_name
string
home_phone
string
label_names
array
last_name
string
mobile_phone
string
organization_name
string
other_phone
string
present_raw_address
string
title
string
website_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Apollo deal

Description

Updates specified fields of an existing apollo.io deal (opportunity), requiring a valid `opportunity id`.

Action Parameters

account_id
string
amount
string
closed_date
string
is_closed
boolean
is_won
boolean
name
string
opportunity_id
stringRequired
opportunity_stage_id
string
owner_id
string
source
string

Action Response

data
objectRequired
error
string
successful
booleanRequired