Help Scout

aid: helpscout
url: https://raw.githubusercontent.com/api-evangelist/helpscout/refs/heads/main/apis.yml
name: Help Scout
kind: company
description: Help Scout is an email-first help desk platform with shared inboxes, live chat, knowledge bases, and a customer
  portal. The Help Scout APIs expose conversations, customers, inboxes, users, workflows, ratings, reports, Docs (knowledge
  base), Beacon (in-app messaging), and webhooks.
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: true
  try_now: true
  public: false
  label: Freemium (free trial) · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/helpscout.png
tags:
- Customer Support
- Help Desk
- Email
- Live Chat
- Knowledge Base
- SaaS
created: '2026-05-08'
modified: '2026-05-30'
specificationVersion: '0.19'
apis:
- aid: helpscout:helpscout-threads-api
  name: Help Scout Threads API
  tags:
  - Threads
  - Replies
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/
    type: Documentation
  description: Append customer replies, agent replies, internal notes, phone, chat, and forwards to an existing conversation
    as new threads.
- aid: helpscout:helpscout-customers-api
  name: Help Scout Customers API
  tags:
  - Customers
  - Contacts
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/customers/list/
    type: Documentation
  description: Manage customer profiles including addresses, emails, phone numbers, chat handles, social profiles, websites,
    and properties.
- aid: helpscout:helpscout-mailboxes-api
  name: Help Scout Mailboxes API
  tags:
  - Mailboxes
  - Inboxes
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/mailboxes/list/
    type: Documentation
  description: Read mailbox / inbox configuration including routing settings, saved replies, custom fields, and folders.
- aid: helpscout:helpscout-users-api
  name: Help Scout Users API
  tags:
  - Users
  - Agents
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/users/list/
    type: Documentation
  description: Retrieve Help Scout user accounts (agents) including roles, permissions, and online/offline status.
- aid: helpscout:helpscout-teams-api
  name: Help Scout Teams API
  tags:
  - Teams
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/teams/list/
    type: Documentation
  description: Manage teams that group users for routing and assignment within shared inboxes.
- aid: helpscout:helpscout-tags-api
  name: Help Scout Tags API
  tags:
  - Tags
  - Categorization
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/tags/list/
    type: Documentation
  description: List, create, and apply tags to conversations for categorization, automation, and reporting.
- aid: helpscout:helpscout-workflows-api
  name: Help Scout Workflows API
  tags:
  - Workflows
  - Automation
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/workflows/list/
    type: Documentation
  description: List automation workflows and trigger them manually against a conversation.
- aid: helpscout:helpscout-custom-fields-api
  name: Help Scout Custom Fields API
  tags:
  - Custom Fields
  - Metadata
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/custom_fields/
    type: Documentation
  description: Read custom field definitions on inboxes and read / update custom field values on conversations.
- aid: helpscout:helpscout-attachments-api
  name: Help Scout Attachments API
  tags:
  - Attachments
  - Files
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/attachments/data/
    type: Documentation
  description: Upload and download attachment data for conversation threads.
- aid: helpscout:helpscout-ratings-api
  name: Help Scout Ratings API
  tags:
  - Ratings
  - Happiness
  - CSAT
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/reports/happiness/
    type: Documentation
  description: Read customer satisfaction ratings (great / okay / not good) attached to conversation threads.
- aid: helpscout:helpscout-reports-api
  name: Help Scout Reports API
  tags:
  - Reports
  - Analytics
  properties:
  - url: https://developer.helpscout.com/mailbox-api/endpoints/reports/
    type: Documentation
  description: Aggregated reports across company performance, conversations, happiness ratings, productivity, and user/team
    statistics.
- aid: helpscout:helpscout-webhooks-api
  name: Help Scout Webhooks API
  tags:
  - Webhooks
  - Events
  properties:
  - url: https://developer.helpscout.com/webhooks/
    type: Documentation
  - url: asyncapi/helpscout-webhooks-asyncapi.yml
    type: AsyncAPI
  description: Subscribe to Help Scout events (convo.created, convo.assigned, convo.tag, customer.created, rating.received)
    for downstream automation. Webhooks include HMAC signatures for verification.
- aid: helpscout:helpscout-docs-api
  name: Help Scout Docs API
  tags:
  - Docs
  - Knowledge Base
  - Articles
  properties:
  - url: https://developer.helpscout.com/docs-api/
    type: Documentation
  description: Manage knowledge-base sites, collections, categories, articles, and search/related content for Help Scout Docs.
- aid: helpscout:helpscout-beacon-api
  name: Help Scout Beacon API
  tags:
  - Beacon
  - Live Chat
  - Embed
  properties:
  - url: https://developer.helpscout.com/beacon-2/
    type: Documentation
  description: Embed Beacon (live chat, help docs, customer portal) into web and mobile applications and pre-fill or update
    Beacon context via the Beacon JS API.
- aid: helpscout:helpscout-chat-api
  name: Help Scout Chat API
  tags:
  - Chat
  - Live Chat
  properties:
  - url: https://developer.helpscout.com/
    type: Documentation
  description: Read and write live chat conversations and messages alongside the email Mailbox API for unified ticketing.
- aid: helpscout:helpscout-apps-api
  name: Help Scout Apps API
  tags:
  - Apps
  - Sidebar
  - Marketplace
  properties:
  - url: https://developer.helpscout.com/apps/
    type: Documentation
  description: Build sidebar applications that render custom content within the Help Scout Inbox UI for partner integrations.
- aid: helpscout:helpscout-conversations-api
  name: Help Scout Conversations API
  description: The Conversations API from Help Scout — 2 operation(s) for conversations.
  tags:
  - Conversations
  properties:
  - type: OpenAPI
    url: openapi/helpscout-conversations-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-customers-api
  name: Help Scout Customers API
  description: The Customers API from Help Scout — 2 operation(s) for customers.
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/helpscout-customers-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-mailboxes-api
  name: Help Scout Mailboxes API
  description: The Mailboxes API from Help Scout — 1 operation(s) for mailboxes.
  tags:
  - Mailboxes
  properties:
  - type: OpenAPI
    url: openapi/helpscout-mailboxes-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-tags-api
  name: Help Scout Tags API
  description: The Tags API from Help Scout — 1 operation(s) for tags.
  tags:
  - Tags
  properties:
  - type: OpenAPI
    url: openapi/helpscout-tags-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-teams-api
  name: Help Scout Teams API
  description: The Teams API from Help Scout — 1 operation(s) for teams.
  tags:
  - Teams
  properties:
  - type: OpenAPI
    url: openapi/helpscout-teams-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-threads-api
  name: Help Scout Threads API
  description: The Threads API from Help Scout — 1 operation(s) for threads.
  tags:
  - Threads
  properties:
  - type: OpenAPI
    url: openapi/helpscout-threads-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-users-api
  name: Help Scout Users API
  description: The Users API from Help Scout — 1 operation(s) for users.
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/helpscout-users-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-webhooks-api
  name: Help Scout Webhooks API
  description: The Webhooks API from Help Scout — 1 operation(s) for webhooks.
  tags:
  - Webhooks
  properties:
  - type: OpenAPI
    url: openapi/helpscout-webhooks-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
- aid: helpscout:helpscout-workflows-api
  name: Help Scout Workflows API
  description: The Workflows API from Help Scout — 1 operation(s) for workflows.
  tags:
  - Workflows
  properties:
  - type: OpenAPI
    url: openapi/helpscout-workflows-api-openapi.yml
  - type: Documentation
    url: https://developer.helpscout.com/mailbox-api/
  - type: APIReference
    url: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/
  - type: GraphQL
    url: graphql/helpscout-graphql.md
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/help-scout/overview
- type: AgenticAccess
  url: agentic-access/helpscout-agentic-access.yml
- type: TrustCenter
  url: security/helpscout-trust-center.yml
- type: DomainSecurity
  url: security/helpscout-domain-security.yml
- type: Authentication
  url: authentication/helpscout-authentication.yml
- type: OAuthScopes
  url: scopes/helpscout-scopes.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/help-scout
- type: Website
  url: https://www.helpscout.com/
- type: Documentation
  url: https://developer.helpscout.com/
- type: APIReference
  url: https://developer.helpscout.com/mailbox-api/
- type: Pricing
  url: https://www.helpscout.com/pricing/
- type: Login
  url: https://secure.helpscout.net/login/
- type: StatusPage
  url: https://status.helpscout.com/
- type: Blog
  url: https://www.helpscout.com/blog/
- type: Support
  url: https://support.helpscout.com/
- type: GitHubOrganization
  url: https://github.com/helpscout
- type: PrivacyPolicy
  url: https://www.helpscout.com/company/legal/privacy/
- type: TermsOfService
  url: https://www.helpscout.com/company/legal/terms-of-service/
- type: Authentication
  url: https://developer.helpscout.com/mailbox-api/overview/authentication/
- type: RateLimits
  url: https://developer.helpscout.com/mailbox-api/overview/rate-limiting/
- type: Webhooks
  url: https://developer.helpscout.com/webhooks/
- type: Plans
  url: plans/helpscout-plans-pricing.yml
- type: RateLimits
  url: rate-limits/helpscout-rate-limits.yml
- type: FinOps
  url: finops/helpscout-finops.yml
- type: Features
  data:
  - REST API at https://api.helpscout.net/v2 with OAuth 2 authentication
  - JSON-only request/response format with HATEOAS resource links
  - Free plan up to 5 users, 1 inbox, 1 Docs site
  - Standard $25/user/mo, Plus $45/user/mo, Pro $75/user/mo (16% off annual)
  - AI Answers add-on at $0.75 per resolution
  - Additional inbox $10/month, additional Docs site $20/month
  - Account-shared rate limit; write requests count double
  - X-RateLimit-Limit-Minute / Remaining-Minute / Retry-After headers
  - Webhooks with HMAC signatures
  - PHP SDK and Laravel/Lumen adapter
  sources:
  - https://www.helpscout.com/pricing/
  - https://developer.helpscout.com/
  - https://developer.helpscout.com/mailbox-api/overview/rate-limiting/
  updated: '2026-05-08'
- type: LlmsText
  url: https://developer.helpscout.com/llms.txt
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com