Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Search saved Apollo contacts by stage, list, and keywords.
apollo.searchContacts searches the connected workspace’s contacts. Use apollo.searchPeople for Apollo’s broader prospect database.
import { automation, onDashboardRun } from "automate.ax"
import { apollo } from "automate.ax/apollo"
export default automation("Find qualified contacts", () => {
onDashboardRun({ title: "Find qualified contacts" })
apollo.searchContacts({
query: "engineering",
stages: ["Qualified"],
perPage: 50,
})
})
| Input | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | None | Name, title, employer, or email keywords. |
stages | ApolloReference[] | No | All | Contact stages to include. |
lists | ApolloReference[] | No | All | Contact lists to include. |
sortBy | "contact_created_at" | "contact_email_last_clicked_at" | "contact_email_last_opened_at" | "contact_last_activity_date" | "contact_updated_at" | No | Provider order | Sort field. |
sortAscending | boolean | No | false | Sort oldest to newest. |
page | number | No | 1 | One-based page. |
perPage | number | No | 100 | Page size from 1 through 100. |
Second argument: { account } | string | IntegrationAccountReference<"apollo"> | No | Project default | Connected workspace. |
{ contacts: ApolloContact[]; pagination: ApolloPagination }.