View as Markdown
Apollo icon

Apollo ACTION

List Metadata

Lists metadata such as stages, sequences, labels, email accounts, or team users. Use this tool to discover valid IDs before calling write tools — e.g., find a contact stage ID for Create or Update Contact, a sequence ID for Add Contacts to Sequence, or an opportunity stage ID for Create or Update Opportunity. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apollo account once, then configure and run List Metadata from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "apollo_io_oauth-list-metadata",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apollo_io_oauth: { authProvisionId: "apn_xxxxxxx" },
    metadataType: "Metadata Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Metadata inputs
Property Type Description
metadataType Metadata Type string
The type of metadata to list. contact_stages — pipeline stages for contacts. account_stages — pipeline stages for accounts. opportunity_stages — pipeline stages for opportunities/deals. sequences — email outreach sequences/campaigns. email_accounts — connected email sending accounts. labels — tags/labels for contacts. users — team members (useful for owner IDs).
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
apollo_io_oauth-list-metadata
Version
0.0.2
App
Apollo
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes