View as Markdown
Zoho Desk icon

Zoho Desk ACTION

List Root Categories

Lists root knowledge base categories for a help center. 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 List Root Categories 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-list-root-categories",
  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.

List Root Categories 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
sortBy Sort By string
Sort the categories by the specified attribute.
Optional
searchValue Search Value string
Filter categories whose names match the provided value.
Optional
visibility Visibility string
Filter categories by visibility (e.g. ALL_USERS).
Optional
departmentId Department ID string
Filter categories associated with the specified department.
Optional Dynamic
hasArticles Has Articles boolean
Return only categories that contain articles when set to true.
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-list-root-categories
Version
0.0.8
App
Zoho Desk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes