View as Markdown
Sharepoint icon

Sharepoint ACTION

Search Sites

Search for sites across the tenant. This is a free-text search across multiple site properties — not an exact slug match.

Backed by the SharePoint Search index and eventually consistent, so newly created or renamed sites may not appear until indexing catches up.

To resolve a known site by path, prefer Get Site for an immediate, exact lookup.

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 Sites 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-sites",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sharepoint: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    select: "Select",
  },
})

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 Sites inputs
Property Type Description
query Query string
The query to search for
Required
select Select string
A comma-separated list of properties to return in the response
Optional
maxResults Max Results integer
The maximum number of results to return
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-sites
Version
0.0.9
App
Sharepoint
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes