# Search Contacts — Intercom

> 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…

- Key: `intercom-search-contacts`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Intercom (`intercom`) — https://pipedream.com/apps/intercom.md
- This page (HTML): https://pipedream.com/apps/intercom/actions/search-contacts
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/intercom/actions/search-contacts/search-contacts.mjs

## Description

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](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/contacts/searchcontacts).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `query` | `string` | Yes | 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). |
| `maxResults` | `integer` | No | Maximum number of contacts to return in a single bounded page (min 1, max 150). Defaults to 50. |
| `startingAfter` | `string` | No | Pagination cursor from a prior call's pages.next.starting_after value. Omit to start from the first page. |
| `fields` | `string[]` | No | 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. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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,
  },
})
```

**TypeScript**

```ts
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**

```bash
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
    }
  }'
```

---

- App: https://pipedream.com/apps/intercom.md · All apps: https://pipedream.com/apps