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.
Help Scout publishes 2 APIs on the APIs.io network: Conversations API and Webhooks API. Tagged areas include Customer Support, Help Desk, Email, Live Chat, and Knowledge Base.
The Help Scout catalog on APIs.io includes 1 event-driven AsyncAPI specification and 1 Spectral governance ruleset.
Help Scout’s developer surface includes authentication, documentation, API reference, pricing, engineering blog, support, and 18 more developer resources.
API Rating
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
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, ...
GRAPHQLPricing Plans
Rate Limits
FinOps
Helpscout Finops
FINOPSFeatures
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...
ASYNCAPIAPI Governance Rules
Resources
Get Started 1
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 1
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 5
Authentication, authorization, and security posture
Operate 4
Status, limits, changes, and where to get help
Commercial 5
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API