View as Markdown
HelpSpot icon

HelpSpot ACTION

Get Requests

Retrieves multiple support requests by ID in a single call. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HelpSpot account once, then configure and run Get Requests 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: "helpspot-get-requests",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    helpspot: { authProvisionId: "apn_xxxxxxx" },
    xRequest: ["Request IDs"],
    fIncludeTimeTotal: true,
  },
})

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 Requests inputs
Property Type Description
xRequest Request IDs string[]
The IDs of the requests to retrieve, e.g., ["12345", "67890"].
Required Dynamic
fIncludeTimeTotal Include Time Total boolean
Set to true to include total tracked time as iTimeTotal (seconds) and sTimeTotal (formatted string) in each response.
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
helpspot-get-requests
Version
0.0.2
App
HelpSpot
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes