View as Markdown
Google Contacts icon

Google Contacts ACTION

Search Contacts

Searches the authenticated user's contacts by name, email address, phone number, organization, or other contact fields. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Contacts account once, then configure and run Search Contacts 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: "google_contacts-search-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_contacts: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    fields: ["Fields"],
  },
})

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.

Search Contacts inputs
Property Type Description
query Query string
The search query used to match contacts by fields such as name, email address, phone number, or organization.
Required
fields Fields string[]
The contact fields on each person to return
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
google_contacts-search-contacts
Version
0.0.2
App
Google Contacts
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes