View as Markdown
Help Scout (API Keys) icon

Help Scout (API Keys) ACTION

Get Article

Retrieve a single article by ID or number. 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 Get Article 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-get-article",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    help_scout_api_keys: { authProvisionId: "apn_xxxxxxx" },
    collectionId: "Collection ID",
    categoryId: "Category 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.

Get Article inputs
Property Type Description
collectionId Collection ID string
The ID of a collection
Required Dynamic
categoryId Category ID string
The ID of a category
Optional Dynamic
articleId Article ID string
The ID or number of an article
Required Dynamic

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-get-article
Version
0.0.1
App
Help Scout (API Keys)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes