View as Markdown
TOPdesk icon

TOPdesk ACTION

Get Knowledge Items

Returns a list of Knowledge Items. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's TOPdesk account once, then configure and run Get Knowledge Items 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: "topdesk-get-knowledge-items",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    topdesk: { authProvisionId: "apn_xxxxxxx" },
    maxResults: 10,
    fields: ["Fields"],
  },
})

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.

Get Knowledge Items inputs
Property Type Description
maxResults Max Results integer
Maximum number of knowledge items to return. Leave empty to return all items.
Optional
fields Fields string[]
Additional fields to include in the response. ID and number are always included.
Optional
query Query string

A FIQL query to filter the response. Use semicolons to combine multiple conditions.

Available filter fields:

  • parent.id, parent.number
  • visibility.sspVisibility, visibility.sspVisibleFrom, visibility.sspVisibleUntil
  • visibility.sspVisibilityFilteredOnBranches, visibility.operatorVisibilityFilteredOnBranches
  • visibility.publicKnowledgeItem, visibility.branches.id, visibility.branches.name
  • manager.id, manager.name
  • status.id, status.name
  • standardSolution.id, standardSolution.name
  • externalLink.id, externalLink.type, externalLink.date
  • archived, news

Operators:

  • == (equals), != (not equals)
  • =gt= (greater than), =ge= (greater than or equal)
  • =lt= (less than), =le= (less than or equal)
  • =in= (in list), =out= (not in list)

Example: parent.id==3fa85f64-5717-4562-b3fc-2c963f66afa6;externalLink.id=in=(oneTool,otherTool)

See the documentation for more information.

Optional
language Language string
The language of the Knowledge Item content, in BCP 47 format (e.g., en)
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
topdesk-get-knowledge-items
Version
0.0.4
App
TOPdesk
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes