# Help Scout (API Keys) — Pipedream Connect

> Simple Customer Service Software and Education

- API slug: `help_scout_api_keys` (use in MCP headers and tool keys)
- Auth: API key (Pipedream-managed)
- Categories: Help Desk & Support
- Website: https://www.helpscout.com
- This page (HTML): https://pipedream.com/apps/help-scout-api-keys
- Tools: 5 actions · 0 triggers

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: help_scout_api_keys`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "help_scout_api_keys",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Get Article:
const result = await mcp.callTool({
  name: "help_scout_api_keys-get-article",
  arguments: {
    collectionId: "Collection ID",
    categoryId: "Category ID",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a Help Scout (API Keys) endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://docsapi.helpscout.net/v1/collections

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9kb2NzYXBpLmhlbHBzY291dC5uZXQvdjEvY29sbGVjdGlvbnM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
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",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (5)

### `help_scout_api_keys-get-article` — Get Article (Read-only)

Retrieve a single article by ID or number. See the documentation

Full schema: https://pipedream.com/apps/help-scout-api-keys/actions/get-article.md

### `help_scout_api_keys-list-articles` — List Articles (Read-only)

Retrieve a list of articles by collection or category. See the documentation

Full schema: https://pipedream.com/apps/help-scout-api-keys/actions/list-articles.md

### `help_scout_api_keys-list-collection-id-options` — List Collection ID Options (Read-only)

Retrieves available options for the Collection ID field.

Full schema: https://pipedream.com/apps/help-scout-api-keys/actions/list-collection-id-options.md

### `help_scout_api_keys-list-site-id-options` — List Site ID Options (Read-only)

Retrieves available options for the Site ID field.

Full schema: https://pipedream.com/apps/help-scout-api-keys/actions/list-site-id-options.md

### `help_scout_api_keys-search-articles` — Search Articles (Read-only)

Search for articles by keyword. See the documentation

Full schema: https://pipedream.com/apps/help-scout-api-keys/actions/search-articles.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt