# Search Files — Sharepoint

> Search for files across the tenant. Supports KQL via the optional query template.

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

## Description

Search for files across the tenant. Supports KQL via the optional query template.

Backed by the [Microsoft Search index](https://learn.microsoft.com/en-us/graph/search-concept-overview) and **eventually consistent** — newly created or modified files may not appear until indexing catches up.

**For immediate, deterministic results, prefer:**
- **Get File by ID** when the ID is known
- **List Files in Folder** for path-based listing
- **Search and Filter Files** for OData `$filter` against a document library

[See the documentation](https://learn.microsoft.com/en-us/graph/api/search-query?view=graph-rest-1.0&tabs=http)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `queryString` | `string` | Yes | The search query containing the search terms |
| `queryTemplate` | `string` | No | Provides a way to decorate the query string. Supports both KQL and query variables. Example: ({searchTerms}) AuthorOWSUSER:Adventure See the documentation for more information. |
| `select` | `string` | No | A comma-separated list of properties to return in the response |
| `size` | `integer` | No | The maximum number of results to return |
| `sortField` | `string` | No | The field to sort the results by |
| `descending` | `boolean` | No | Whether to sort the results in descending order |

## 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": "sharepoint",
      },
    },
  },
)

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: "sharepoint-search-files",
  arguments: {
    queryString: "Query String",
    queryTemplate: "Query Template",
  },
})
```

**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: "sharepoint-search-files",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sharepoint: { authProvisionId: "apn_xxxxxxx" },
    queryString: "Query String",
    queryTemplate: "Query Template",
  },
})

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": "sharepoint-search-files",
    "configured_props": {
      "sharepoint": { "authProvisionId": "apn_xxxxxxx" },
      "queryString": "Query String",
      "queryTemplate": "Query Template"
    }
  }'
```

---

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