View as Markdown
Intercom icon

Intercom ACTION

Search Contacts

Search Intercom contacts by a query string (POST /contacts/search). Returns a bounded page of matching contacts, each including id, email, and external_id so you can copy the appropriate value into Reply To Conversation's Intercom User ID, Email, or User ID prop. If pages.next.starting_after is present in the response, call this action again with that cursor in Starting After to retrieve the next page. Pass Fields (e.g. ["id", "email", "external_id"]) to limit each returned contact to only those keys. Example: set Query to acme to find all contacts whose email contains acme. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Intercom 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: "intercom-search-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    intercom: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    maxResults: 10,
  },
})

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 value to search for. Matched against the contact name or email field (whichever contains the value) using the ~ (contains) operator (e.g. jane.doe@example.com or Jane Doe).
Required
maxResults Max Results integer
Maximum number of contacts to return in a single bounded page (min 1, max 150). Defaults to 50.
Optional
startingAfter Starting After string
Pagination cursor from a prior call's pages.next.starting_after value. Omit to start from the first page.
Optional
fields Fields string[]
When provided, each returned contact object is limited to only these field names (e.g. ["id", "email", "external_id"]). Omit to return the full contact object.
Optional

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
intercom-search-contacts
Version
0.0.2
App
Intercom
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes