View as Markdown
Zoho Desk icon

Zoho Desk ACTION

Search Articles

Searches for knowledge base articles. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zoho Desk account once, then configure and run Search Articles 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: "zoho_desk-search-articles",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zoho_desk: { authProvisionId: "apn_xxxxxxx" },
    orgId: "Organization ID",
    portalId: "Portal ID",
  },
})

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 Articles inputs
Property Type Description
orgId Organization ID string
The ID of the organization
Required Dynamic
portalId Portal ID string
Select the help center portal to target.
Required Dynamic
searchStr Search String string
The keywords to search for within articles.
Required
categoryId Category ID string
Filter by the ID(s) of the categories the articles belong to. Use comma-separated IDs to include multiple categories.
Optional Dynamic
sortBy Sort By string
Sort the results by created time or relevance. Use -createdTime for descending order.
Optional
searchKeyWordMatch Match Type string
Specify how multiple search keywords must be matched in the results.
Optional
maxResults Max Results integer
Maximum number of results to return. Set to blank to return everything.
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
zoho_desk-search-articles
Version
0.0.8
App
Zoho Desk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes