View as Markdown
Help Scout icon

Help Scout ACTION

List Customer ID Options

Retrieves available options for the Customer ID field.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Help Scout account once, then configure and run List Customer ID Options 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-list-customer-id-options",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    help_scout: { authProvisionId: "apn_xxxxxxx" },
    page: 10,
  },
})

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 Customer ID Options inputs
Property Type Description
page Page integer
The page of results to retrieve, zero-based.
Required

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-list-customer-id-options
Version
0.0.1
App
Help Scout
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes