Apollo

Sales intelligence: search and enrich people and companies, search and create contacts.

5 actions API key 3 read2 write Calls api.apollo.io

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "apollo" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Create contactwriteapollo.create_contactSave a new contact in your Apollo account. With run_dedupe true, an existing match is updated and returned instead of creating a duplicate.

Input	Type		Description
`first_name`	string	Optional	First name
`last_name`	string	Optional	Last name
`email`	string	Optional	Email address
`organization_name`	string	Optional	Employer
`title`	string	Optional	Job title
`run_dedupe`	boolean	Optional	Update an existing matching contact instead of duplicating

TypeScript

await setu.execute({
  userId: "user_1",
  action: "apollo.create_contact",
  input: {},
});

Enrich organizationreadapollo.enrich_organizationLook up a company by domain (or LinkedIn URL / website) and return Apollo's firmographics. Costs 1 Apollo credit per company.

Input	Type		Description
`domain`	string	Optional	Company domain without www, e.g. apollo.io
`linkedin_url`	string	Optional	Company LinkedIn URL
`website`	string	Optional	Full website URL
`name`	string	Optional	Company name, only to improve a match on another identifier

TypeScript

await setu.execute({
  userId: "user_1",
  action: "apollo.enrich_organization",
  input: {},
});

Enrich personwriteapollo.enrich_personMatch one person by email, name plus company, or LinkedIn URL and return their Apollo profile, including email. Spends Apollo credits.

Input	Type		Description
`email`	string	Optional	Email address
`first_name`	string	Optional	First name
`last_name`	string	Optional	Last name
`name`	string	Optional	Full name
`organization_name`	string	Optional	Employer name
`domain`	string	Optional	Employer domain without www
`linkedin_url`	string	Optional	LinkedIn profile URL
`id`	string	Optional	Apollo person id

TypeScript

await setu.execute({
  userId: "user_1",
  action: "apollo.enrich_person",
  input: {},
});

Search contactsreadapollo.search_contactsSearch the contacts already saved in your Apollo account by name, title, employer or email keywords.

Input	Type		Description
`q_keywords`	string	Optional	Keywords: names, titles, employers or emails
`page`	integer	Optional	Page number
`per_page`	integer	Optional	Results per page (max 100)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "apollo.search_contacts",
  input: {},
});

Search peoplereadapollo.search_peopleSearch Apollo's database for people by keywords, name, title, location, seniority or employer domain. Free of credits; results hide emails and phones, use enrich_person for those.

Input	Type		Description
`q_keywords`	string	Optional	Keywords
`q_person_name`	string	Optional	Person name
`person_title`	string	Optional	One job title to match
`person_location`	string	Optional	One person location, e.g. California, US
`person_seniority`	string	Optional	One seniority, e.g. vp, director, manager
`organization_domain`	string	Optional	One employer domain, e.g. apollo.io
`page`	integer	Optional	Page number
`per_page`	integer	Optional	Results per page (max 100)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "apollo.search_people",
  input: {},
});