View as Markdown
WorkFlowy icon

WorkFlowy ACTION

Search Nodes

Searches all WorkFlowy nodes by keyword. WorkFlowy has no dedicated search endpoint, so this exports all nodes (GET /api/v1/nodes-export) and filters client-side by matching the query against each node's name and note. Use this to discover node IDs before running Create Node (as a parent) or Update Node. Note: the export endpoint is rate limited to 1 request per minute. Returns matching nodes with their IDs and content. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's WorkFlowy account once, then configure and run Search Nodes 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: "workflowy-search-nodes",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    workflowy: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    maxResults: 10,
  },
})

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 Nodes inputs
Property Type Description
query Query string
Keyword to match (case-insensitive) against each node's name and note.
Required
maxResults Max Results integer
Maximum number of matching nodes to return. Min 1, max 1000. Defaults to 100.
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
workflowy-search-nodes
Version
0.0.2
App
WorkFlowy
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes