Help Scout · Capability

Help Scout Mailbox API — Users

Help Scout Mailbox API — Users. 1 operations. Lead operation: List users. Self-contained Naftiko capability covering one Helpscout business surface.

Run with Naftiko HelpscoutUsers

What You Can Do

GET
Listusers — List users
/v1/users

MCP Tools

list-users

List users

read-only idempotent

Capability Spec

helpscout-users.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Help Scout Mailbox API — Users
  description: 'Help Scout Mailbox API — Users. 1 operations. Lead operation: List users. Self-contained Naftiko capability
    covering one Helpscout business surface.'
  tags:
  - Helpscout
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HELPSCOUT_API_KEY: HELPSCOUT_API_KEY
capability:
  consumes:
  - type: http
    namespace: helpscout-users
    baseUri: https://api.helpscout.net/v2
    description: Help Scout Mailbox API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: List users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.HELPSCOUT_API_KEY}}'
  exposes:
  - type: rest
    namespace: helpscout-users-rest
    port: 8080
    description: REST adapter for Help Scout Mailbox API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: GET
        name: listusers
        description: List users
        call: helpscout-users.listusers
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: helpscout-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Help Scout Mailbox API — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-users
      description: List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helpscout-users.listusers
      outputParameters:
      - type: object
        mapping: $.