View as Markdown
Help Scout (API Keys) icon

Help Scout (API Keys) ACTION

Search Articles

Search for articles by keyword. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Help Scout (API Keys) account once, then configure and run Search Articles 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: "help_scout_api_keys-search-articles",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    help_scout_api_keys: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    collectionId: "Collection 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.

Search Articles inputs
Property Type Description
query Query string
The keyword to search for
Required
collectionId Collection ID string
The ID of a collection
Optional Dynamic
siteId Site ID string
The ID of a site
Optional Dynamic
status Status string
The status of the articles to retrieve
Optional
visibility Visibility string
The visibility of the articles to search for
Optional
page Page integer
The page number to retrieve
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
help_scout_api_keys-search-articles
Version
0.0.1
App
Help Scout (API Keys)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes