View as Markdown
Help Scout (API Keys) icon

Help Scout (API Keys) ACTION

List Articles

Retrieve a list of articles by collection or category. 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 List 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-list-articles",
  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.

List Articles 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
status Status string
The status of the articles to retrieve
Optional
sort Sort string
The field to sort the articles by
Optional
order Order string
The order to sort the articles by
Optional
page Page integer
The page number to retrieve
Optional
pageSize Page Size integer
The number of articles to retrieve per page
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-list-articles
Version
0.0.1
App
Help Scout (API Keys)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes