View as Markdown
HelpSpot icon

HelpSpot ACTION

Search Requests

Searches for support requests using one or more filter criteria. 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 Search 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-search-requests",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    helpspot: { authProvisionId: "apn_xxxxxxx" },
    sSearch: "Search Text",
    anyall: "Match Mode",
  },
})

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 Requests inputs
Property Type Description
sSearch Search Text string
Full-text search string to match against request content.
Optional
anyall Match Mode string
Whether all filters must match (default) or any single filter is sufficient.
Optional
xRequest Request ID string
The ID of the request, e.g., 12345.
Optional Dynamic
xCategory Category string
The category id of the request.
Optional Dynamic
xStatus Status string
Select a status of the request
Optional Dynamic
fOpen Open/Closed integer
Filter by whether the request is open or closed.
Optional
xPersonAssignedTo Assigned To string
The ID of the staff member the request is assigned to. Use the List Active Staff action to retrieve valid staff IDs.
Optional
sUserId User ID string
Filter by customer user ID, e.g., user_12345.
Optional
sFirstName First Name string
Filter by customer first name.
Optional
sLastName Last Name string
Filter by customer last name.
Optional
sEmail Email string
Filter by customer email address.
Optional
sPhone Phone string
Filter by customer phone number.
Optional
afterDate Opened After Date string
Return requests opened after this date. Provide a Unix timestamp or a valid date string (e.g. 2024-01-01).
Optional
beforeDate Opened Before Date string
Return requests opened before this date. Provide a Unix timestamp or a valid date string (e.g. 2024-12-31).
Optional
closedAfterDate Closed After Date string
Return requests closed after this date. Provide a Unix timestamp or a valid date string (e.g. 2024-01-01).
Optional
closedBeforeDate Closed Before Date string
Return requests closed before this date. Provide a Unix timestamp or a valid date string (e.g. 2024-12-31).
Optional
orderBy Order By string
Field name to sort results by (e.g. xRequest, sLastName, dtGMTOpened).
Optional
orderByDir Order Direction string
Sort direction for the Order By field.
Optional
length Max Results integer
Maximum number of requests to return.
Optional
fRawValues Raw Values boolean
Set to true to return numeric IDs instead of their text representations.
Optional
fIncludeTimeTotal Include Time Total boolean
Set to true to include total tracked time as iTimeTotal (seconds) and sTimeTotal (formatted string) in each result.
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-search-requests
Version
0.0.2
App
HelpSpot
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes