View as Markdown
Sharepoint icon

Sharepoint ACTION

Search and Filter Files

Search and filter SharePoint files based on metadata and custom columns. This action allows you to query files using SharePoint's custom properties, managed metadata, and other column values. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sharepoint account once, then configure and run Search and Filter Files 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: "sharepoint-search-and-filter-files",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sharepoint: { authProvisionId: "apn_xxxxxxx" },
    siteId: "Site",
    listId: "List / Document Library",
  },
})

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 and Filter Files inputs
Property Type Description
siteId Site string
Identifier of a site. This is either the composite ID (e.g. contoso.sharepoint.com,<guid>,<guid> or a server-relative path in the form {hostname}:/{server-relative-path} (e.g. contoso.sharepoint.com:/sites/site-name)
Required Dynamic
listId List / Document Library string
Select the document library or list to search in
Required Dynamic
filter Filter string
Filter items using OData syntax. To filter by custom columns, use fields/ColumnInternalName. Example: fields/Title eq 'My File' or fields/Status eq 'Approved'. See OData filter documentation
Optional
select Select Fields string[]
Select the specific metadata fields to return in the response. If none are selected, all fields will be returned.
Optional Dynamic
orderBy Order By string
Specify the sort order of the results using OData syntax. Example: fields/Created desc or fields/Title asc.
Optional
expandFields Expand Fields? boolean
Set to true to retrieve custom metadata and column values. Defaults to true.
Optional
maxResults Max Results integer
The maximum number of results to return. Defaults to 100.
Optional
honorNonIndexedQueries Honor Non-Indexed Queries boolean
Enable filtering on non-indexed columns (e.g. fields/FileLeafRef, fields/DocIcon). By default, SharePoint rejects $filter against non-indexed columns on lists above the list view threshold (5,000 items). Setting this to true sends the Prefer: HonorNonIndexedQueriesWarningMayFailRandomly header, which permits the query — but per Microsoft, these requests may fail randomly, especially on large lists. Leave off unless you've hit the error.
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
sharepoint-search-and-filter-files
Version
0.1.3
App
Sharepoint
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes