Help Scout website screenshot

Help Scout

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.

17 APIs 10 Features
Customer SupportHelp DeskEmailLive ChatKnowledge BaseSaaS

APIs

Help Scout Conversations API

Create, retrieve, list, update, and delete conversations including threads, attachments, custom fields, tags, and snooze states. Core Mailbox API resource for ticket-style custo...

Help Scout Threads API

Append customer replies, agent replies, internal notes, phone, chat, and forwards to an existing conversation as new threads.

Help Scout Customers API

Manage customer profiles including addresses, emails, phone numbers, chat handles, social profiles, websites, and properties.

Help Scout Mailboxes API

Read mailbox / inbox configuration including routing settings, saved replies, custom fields, and folders.

Help Scout Users API

Retrieve Help Scout user accounts (agents) including roles, permissions, and online/offline status.

Help Scout Teams API

Manage teams that group users for routing and assignment within shared inboxes.

Help Scout Tags API

List, create, and apply tags to conversations for categorization, automation, and reporting.

Help Scout Workflows API

List automation workflows and trigger them manually against a conversation.

Help Scout Custom Fields API

Read custom field definitions on inboxes and read / update custom field values on conversations.

Help Scout Attachments API

Upload and download attachment data for conversation threads.

Help Scout Ratings API

Read customer satisfaction ratings (great / okay / not good) attached to conversation threads.

Help Scout Reports API

Aggregated reports across company performance, conversations, happiness ratings, productivity, and user/team statistics.

Help Scout Webhooks API

Subscribe to Help Scout events (convo.created, convo.assigned, convo.tag, customer.created, rating.received) for downstream automation. Webhooks include HMAC signatures for veri...

Help Scout Docs API

Manage knowledge-base sites, collections, categories, articles, and search/related content for Help Scout Docs.

Help Scout Beacon API

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.

Help Scout Chat API

Read and write live chat conversations and messages alongside the email Mailbox API for unified ticketing.

Help Scout Apps API

Build sidebar applications that render custom content within the Help Scout Inbox UI for partner integrations.

Collections

Help Scout Mailbox API

OPEN

GraphQL

Help Scout GraphQL Schema

This conceptual GraphQL schema models the Help Scout customer support and help desk platform. It covers the full surface of the Help Scout Mailbox API v2, Docs API, Beacon API, ...

GRAPHQL

Pricing Plans

Helpscout Plans Pricing

7 plans

PLANS

Rate Limits

Helpscout Rate Limits

3 limits

RATE LIMITS

FinOps

Helpscout Finops

FINOPS

Features

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

Event Specifications

Help Scout Webhooks

Help Scout publishes webhook events from the Mailbox, Beacon, Docs, and organization surfaces to subscriber-configured URLs. Each delivery is an HTTP POST containing a JSON body...

ASYNCAPI

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
APIReference
APIReference
💰
Pricing
Pricing
🔗
Login
Login
🟢
StatusPage
StatusPage
📰
Blog
Blog
💬
Support
Support
👥
GitHubOrganization
GitHubOrganization
📜
PrivacyPolicy
PrivacyPolicy
📜
TermsOfService
TermsOfService
🔑
Authentication
Authentication
🔗
RateLimits
RateLimits
🔗
Webhooks
Webhooks
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
🔗
LlmsText
LlmsText

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Help Scout Mailbox API
  version: '2.0'
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://api.helpscout.net/v2/oauth2/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: List conversations
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/conversations
      params:
      - name: page
        value: ''
        type: query
      - name: status
        value: ''
        type: query
    docs: List conversations
  - info:
      name: Create conversation
      type: http
    http:
      method: POST
      url: https://api.helpscout.net/v2/conversations
      body:
        type: json
        data: '{}'
    docs: Create conversation
  - info:
      name: Get conversation
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/conversations/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get conversation
  - info:
      name: Update conversation
      type: http
    http:
      method: PATCH
      url: https://api.helpscout.net/v2/conversations/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update conversation
  - info:
      name: Delete conversation
      type: http
    http:
      method: DELETE
      url: https://api.helpscout.net/v2/conversations/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete conversation
- info:
    name: Threads
    type: folder
  items:
  - info:
      name: Create thread
      type: http
    http:
      method: POST
      url: https://api.helpscout.net/v2/conversations/:id/threads
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create thread
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List customers
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/customers
    docs: List customers
  - info:
      name: Create customer
      type: http
    http:
      method: POST
      url: https://api.helpscout.net/v2/customers
      body:
        type: json
        data: '{}'
    docs: Create customer
  - info:
      name: Get customer
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/customers/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get customer
  - info:
      name: Update customer
      type: http
    http:
      method: PATCH
      url: https://api.helpscout.net/v2/customers/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update customer
- info:
    name: Mailboxes
    type: folder
  items:
  - info:
      name: List mailboxes
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/mailboxes
    docs: List mailboxes
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List users
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/users
    docs: List users
- info:
    name: Teams
    type: folder
  items:
  - info:
      name: List teams
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/teams
    docs: List teams
- info:
    name: Tags
    type: folder
  items:
  - info:
      name: List tags
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/tags
    docs: List tags
- info:
    name: Workflows
    type: folder
  items:
  - info:
      name: List workflows
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/workflows
    docs: List workflows
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List webhooks
      type: http
    http:
      method: GET
      url: https://api.helpscout.net/v2/webhooks
    docs: List webhooks
  - info:
      name: Create webhook
      type: http
    http:
      method: POST
      url: https://api.helpscout.net/v2/webhooks
      body:
        type: json
        data: '{}'
    docs: Create webhook
bundled: true