View as Markdown
Freshdesk icon

Freshdesk ACTION

List Agents

List all agents in Freshdesk. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Freshdesk account once, then configure and run List Agents 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: "freshdesk-list-agents",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    freshdesk: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    mobile: "Mobile",
  },
})

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 Agents inputs
Property Type Description
email Email string
Filter results by email address
Optional
mobile Mobile string
Filter results by mobile number
Optional
phone Phone string
Filter results by phone number
Optional
state State string
Filter results by state
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
freshdesk-list-agents
Version
0.0.10
App
Freshdesk
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes