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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "intercom-search-contacts",
"configured_props": {
"intercom": { "authProvisionId": "apn_xxxxxxx" },
"query": "Query",
"maxResults": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "intercom",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "intercom-search-contacts",
arguments: {
query: "Query",
maxResults: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗