View as Markdown
Sharepoint icon

Sharepoint ACTION

Find Files in List with Metadata

Search and filter items in a SharePoint list based on metadata and custom columns. See docs here
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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.

Find Files in List with Metadata inputs
Property Type Description
siteId Site string
Select the SharePoint site.
Required Dynamic
listId List string
Select the list or document library to search within.
Required Dynamic
returnFields Fields to Return string[]
Select which custom fields to return. If left empty, all custom fields are returned.
Optional Dynamic
filter Filter Query string
OData filter query. To filter by a custom column, use the format fields/InternalName eq 'Value'. The field picker for 'Fields to Return' shows the InternalName in parentheses.
Optional
orderby Order By string
OData order by query (e.g., lastModifiedDateTime desc). To sort by a custom field, use fields/InternalName asc.
Optional
select Top-level Properties string[]
Select which top-level item properties to return. If not specified, a default set is returned. id and webUrl are always returned.
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-find-files-with-metadata
Version
0.1.3
App
Sharepoint
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes