Skip to main content
Help Scout
Help Scout
36 actions · 2 auth methods
Ticketing

Authentication

OAuth 2.0 - Client Credentials

Best for server-to-server integrations with no user interaction. Acts with app-level permissions, not tied to a user.Guides: Connector Profile, Link Account

OAuth 2.0 - Authorization Code

Recommended for user-facing integrations. Each user authorizes access scoped to their Help Scout permissions.Guides: Connector Profile, Link Account
Actions
36 actions
Action
Description
List Conversations
Retrieve a paginated list of conversations across one or more mailboxes.
Get Conversation
Retrieve the full details of a single conversation by its ID.
Create Conversation
Create a new conversation in a mailbox with an initial thread.
Update Conversation
Apply a single JSON Patch operation to update one field of a conversation.
Delete Conversation
Permanently delete a conversation by its ID.
List Conversation Threads
Retrieve all threads (messages, notes, replies) for a conversation.
Create Reply Thread
Add an outgoing reply to an existing conversation.
Create Note Thread
Add an internal note to an existing conversation.
Update Conversation Tags
Replace all tags on a conversation with a new set of tags.
List Customers
Retrieve a paginated list of customers with optional filters.
Get Customer
Retrieve full profile details of a single customer by their ID.
Create Customer
Create a new customer record in Help Scout.
Update Customer
Apply one or more JSON Patch operations to update a customer record.
Delete Customer
Permanently delete a customer record by its ID.
List Customer Emails
Retrieve all email addresses associated with a specific customer.
List Customer Phones
Retrieve all phone numbers associated with a specific customer.
List Mailboxes
Retrieve a list of all mailboxes in the Help Scout account.
Get Mailbox
Retrieve details of a specific mailbox by its ID.
List Mailbox Custom Fields
Retrieve all custom fields configured for a mailbox.
List Mailbox Folders
Retrieve all folders within a specific mailbox.
List Mailbox Saved Replies
Retrieve all saved replies for a mailbox.
Get Mailbox Saved Reply
Retrieve a single saved reply by its ID.
Create Mailbox Saved Reply
Create a new saved reply in a mailbox.
Update Mailbox Saved Reply
Update an existing saved reply in a mailbox.
Delete Mailbox Saved Reply
Permanently delete a saved reply from a mailbox.
List Tags
Retrieve a paginated list of all tags in the Help Scout account.
Get Tag
Retrieve a single tag by its ID.
List Teams
Retrieve a paginated list of all teams in the Help Scout account.
List Team Members
Retrieve all members of a specific team.
List Users
Retrieve a paginated list of all users (agents) in the Help Scout account.
Get User
Retrieve the full profile of a specific user by their ID.
List User Statuses
Retrieve the current availability status of all users in the Help Scout account.
Get User Status
Retrieve the current availability status of a specific user.
Get Current User
Retrieve the profile of the currently authenticated user or app.
List Workflows
Retrieve a paginated list of all workflows in the Help Scout account.
Run Workflow
Manually trigger a manual workflow on one or more conversations.

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/helpscout/filled/png

Connector Profile

Help Scout - OAuth 2.0 - Client Credentials
https://stackone-logos.com/api/helpscout/filled/png

Connector Profile

Help Scout - OAuth 2.0 - Authorization Code
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/helpscout/filled/png

Link Account

Help Scout - OAuth 2.0 - Client Credentials
https://stackone-logos.com/api/helpscout/filled/png

Link Account

Help Scout - OAuth 2.0 - Authorization Code
4

Use Actions

Invoke actions using one of the methods below: