help-scout · 129 tools · no triggers
Connect it
run auth help-scout
run auth help-scout --scope team # shared with the organization
Use it
run help-scout # common commands
run help-scout --all # every command
import { helpScout } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
create-conversation | Tool to create a new conversation in Help Scout. Use when creating email, phone, or chat conversations with customer threads. |
create-customer | Tool to create a new customer in Help Scout with contact details and profile information. |
create-organization | Tool to create a new organization in Help Scout. Use when you need to create a company profile with associated domains, contact information, and metadata. |
create-webhook | Tool to create a new webhook subscription in Help Scout to receive real-time event notifications. |
get-conversation | Tool to retrieve a specific conversation by ID from Help Scout. |
get-customer | Tool to get a specific customer by ID from Help Scout. Use when you need to retrieve detailed customer information including contact details, profile… |
get-inbox | Tool to retrieve a specific inbox by ID with details including name, email, and timestamps. |
get-organization | Tool to retrieve a specific organization by ID from Help Scout. |
get-resource-owner | Tool to get the authenticated user’s profile information. Use when you need to retrieve details about the current user. |
get-user | Tool to retrieve a specific user by ID from Help Scout. Use when you need detailed information about a user including their role, contact details, and profile data. |
list-conversations | Tool to list and filter conversations from Help Scout. Use when you need to retrieve multiple conversations, search by status/tags/assignee, or… |
list-customers | Tool to list customers in Help Scout with optional filters for name, email, or modification date. |
list-inboxes | Tool to list all mailboxes (inboxes) the user has access to with pagination support. |
list-organizations | Tool to list all organizations (companies) in Help Scout with optional filtering and sorting. |
list-users | Tool to list all users in the Help Scout account with optional filters for mailbox or email. |
update-conversation | Tool to update specific properties of a Help Scout conversation using JSON Patch format. |
update-customer | Tool to update an existing customer in Help Scout using JSON Patch operations. |
update-organization | Tool to update an organization in Help Scout. Use when you need to modify organization details such as name, website, domains, or contact information. |
All 129 tools
All 129 tools
| Tool | What it does |
|---|---|
create-chat-handle | Tool to create a chat handle for a Help Scout customer. Use when you need to add a chat platform username (like Skype, AIM, Yahoo) to a customer’s profile. |
create-chat-thread | Tool to create a new chat thread on a Help Scout conversation. |
create-conversation | Tool to create a new conversation in Help Scout. Use when creating email, phone, or chat conversations with customer threads. |
create-customer | Tool to create a new customer in Help Scout with contact details and profile information. |
create-customer-address | Tool to create an address for a Help Scout customer. Use when you need to add a physical address to a customer’s profile. |
create-customer-email | Tool to create an email for a customer in Help Scout. Use when you need to add a new email address to a customer’s profile. |
create-customer-phone | Tool to create a phone number for a Help Scout customer. Use when adding contact phone numbers to customer profiles. |
create-customer-property | Tool to create a customer property definition in Help Scout. |
create-customer-thread | Tool to create a new customer thread on a Help Scout conversation. |
create-customer-website | Tool to create a website entry for a customer in Help Scout. |
create-note | Tool to create a new note thread on a Help Scout conversation. |
create-organization | Tool to create a new organization in Help Scout. Use when you need to create a company profile with associated domains, contact information, and metadata. |
create-organization-property | Tool to create a new custom property definition for organizations in Help Scout. |
create-phone-thread | Tool to create a new phone thread on a Help Scout conversation. |
create-reply-thread | Tool to create a new reply thread on a Help Scout conversation. |
create-saved-reply | Tool to create a saved reply for a mailbox in Help Scout. Use when you need to create reusable message templates for email or chat responses. |
create-social-profile | Tool to create a social profile for a customer in Help Scout. |
create-webhook | Tool to create a new webhook subscription in Help Scout to receive real-time event notifications. |
delete-chat-handle | Tool to delete a chat handle for a customer. Use when you need to remove a chat handle associated with a customer account. |
delete-conversation | Tool to move a conversation to the deleted folder. Use when you need to delete a conversation. |
delete-customer | Tool to permanently delete a customer by ID from Help Scout. |
delete-customer-address | Tool to delete a customer’s address from Help Scout. Use when you need to remove address information associated with a specific customer account. |
delete-customer-email | Tool to delete an email for a customer. Use when you need to remove a customer’s email address from Help Scout. |
delete-customer-phone | Tool to delete a customer’s phone number from Help Scout. Use when you need to remove a phone number associated with a specific customer account. |
delete-customer-property | Tool to perform a soft delete on a customer property definition. |
delete-customer-website | Tool to delete a website for a customer. Use when you need to remove a website from a customer record. |
delete-organization | Tool to delete an organization by ID. Use when removing an organization from Help Scout. |
delete-organization-property-customer-tier | Tool to delete a customer tier property definition from organizations. |
delete-saved-reply | Tool to delete a saved reply from a mailbox. Use when you need to permanently remove a saved reply. |
delete-snooze | Tool to delete a snooze on a conversation. Use when you need to remove a snooze from a conversation, which will place it into its new home folder… |
delete-social-profile | Tool to delete a social profile for a customer in Help Scout. |
delete-thread-schedule | Tool to unschedule a scheduled thread in a conversation. Use when you need to convert a scheduled thread to a draft thread. |
delete-webhook | Tool to permanently delete a webhook subscription from Help Scout. |
download-attachment | Tool to download an attachment file from a Help Scout conversation. |
get-attachment-data | Tool to retrieve attachment data for a specific attachment. Returns base64-encoded attachment content. |
get-busy-times-report | Tool to get busiest time of day report showing conversation volume by day and hour. |
get-chat-report | Tool to retrieve comprehensive chat report statistics from Help Scout. |
get-company-customers-helped-report | Tool to retrieve company customers helped report showing distinct customer count receiving support. |
get-company-drilldown-report | Tool to retrieve company drilldown report showing underlying conversation data for company statistics. |
get-company-report | Tool to retrieve overall company performance report from Help Scout. |
get-conversation | Tool to retrieve a specific conversation by ID from Help Scout. |
get-conversations-drilldown | Tool to get conversations drilldown report from Help Scout. Use when you need detailed conversation data for a specific time period. |
get-conversations-field-drilldown | Tool to get conversations drilldown by field report from Help Scout. |
get-conversations-report | Tool to get overall conversations report with statistics on conversation volume, channels, and trends. |
get-customer | Tool to get a specific customer by ID from Help Scout. Use when you need to retrieve detailed customer information including contact details, profile… |
get-customer-address | Tool to retrieve a customer’s address from Help Scout. Use when you need to fetch the physical address associated with a specific customer account. |
get-docs-report | Tool to retrieve overall docs performance report from Help Scout. |
get-email-report | Tool to retrieve email report with volume, resolution, and response metrics from Help Scout. |
get-first-response-time-report | Tool to retrieve first response time productivity report showing average response duration. |
get-happiness-ratings-report | Tool to retrieve happiness ratings report with customer satisfaction scores and feedback from Help Scout. |
get-happiness-report | Tool to retrieve overall happiness report from Help Scout. Returns customer satisfaction metrics including ratings percentages, counts, and happiness… |
get-inbox | Tool to retrieve a specific inbox by ID with details including name, email, and timestamps. |
get-new-conversations-drilldown | Tool to get new conversations drilldown report showing underlying conversation data for new conversations created within a time period. |
get-new-conversations-report | Tool to get new conversations report showing conversation counts over time intervals. |
get-organization | Tool to retrieve a specific organization by ID from Help Scout. |
get-organization-conversations | Tool to get conversations associated with an organization in Help Scout. |
get-organization-customers | Tool to get customers associated with an organization in Help Scout. |
get-organization-property | Tool to retrieve a single organization property definition by its slug identifier. |
get-phone-report | Tool to retrieve phone report statistics from Help Scout. Returns metrics like phone conversations, phone calls created, and customer counts for a specified period. |
get-productivity-report | Tool to retrieve productivity overall report showing comprehensive team performance metrics. |
get-received-messages-report | Tool to retrieve received messages statistics report from Help Scout. |
get-replies-sent-report | Tool to get replies sent productivity report showing reply volume metrics over time. |
get-resolution-time-report | Tool to retrieve resolution time productivity report showing average time to resolve conversations. |
get-resolved-report | Tool to retrieve productivity resolved report from Help Scout. |
get-resource-owner | Tool to get the authenticated user’s profile information. Use when you need to retrieve details about the current user. |
get-routing-config | Tool to retrieve routing configuration for a mailbox inbox. Use when you need to check assignment settings, rotation status, or user eligibility for… |
get-saved-reply | Tool to retrieve a specific saved reply from a mailbox. Use when you need to get details about a saved reply template including its text content for email and chat. |
get-tag | Tool to retrieve a specific tag by ID from Help Scout. Use when you need to get details about a tag including its name, slug, and color. |
get-user | Tool to retrieve a specific user by ID from Help Scout. Use when you need detailed information about a user including their role, contact details, and profile data. |
get-user-chat-report | Tool to retrieve user/team chat report statistics from Help Scout. |
get-user-conversation-history | Tool to retrieve detailed conversation history for a specific user over a designated timeframe. |
get-user-customers-helped-report | Tool to retrieve user customers helped report showing distinct customer count receiving support from a specific user. |
get-user-drilldown | Tool to get user drilldown report from Help Scout. Use when you need detailed conversation data for a specific user within a time period. |
get-user-happiness-report | Tool to retrieve user happiness report from Help Scout. Returns customer satisfaction metrics for a specific user including ratings percentages… |
get-user-ratings-report | Tool to retrieve user happiness ratings drilldown report showing customer satisfaction ratings for a specific user. |
get-user-replies-report | Tool to retrieve user replies report showing the number of replies sent by a specific user over time. |
get-user-report | Tool to retrieve overall user/team performance report from Help Scout. |
get-user-resolutions-report | Tool to retrieve user resolutions report showing the number of conversations resolved by a specific user over time. |
get-user-status | Tool to get the status of a user in Help Scout. Use when you need to check a user’s email availability (active/away) or chat status across mailboxes. |
get-volume-by-channel-report | Tool to retrieve conversation volume by channel (email, chat, phone) over a specified time period. |
get-webhook | Tool to retrieve a specific webhook by ID from Help Scout. Use when you need to view webhook configuration details including URL, events, state, and other settings. |
list-chat-handles | Tool to list all chat handles for a specific customer in Help Scout. |
list-conversations | Tool to list and filter conversations from Help Scout. Use when you need to retrieve multiple conversations, search by status/tags/assignee, or… |
list-customer-emails | Tool to list all emails for a specific customer in Help Scout. |
list-customer-phones | Tool to list all phone numbers for a specific Help Scout customer. |
list-customer-properties | Tool to list all customer property definitions. Use when you need to view all custom properties configured for customers in the Help Scout account. |
list-customers | Tool to list customers in Help Scout with optional filters for name, email, or modification date. |
list-customer-websites | Tool to list all websites associated with a specific customer in Help Scout. |
list-inbox-custom-fields | Tool to list all custom fields configured for a specific inbox. |
list-inboxes | Tool to list all mailboxes (inboxes) the user has access to with pagination support. |
list-inbox-folders | Tool to retrieve all folders within a specific inbox/mailbox. |
list-organizations | Tool to list all organizations (companies) in Help Scout with optional filtering and sorting. |
list-organizations-properties | Tool to list all organization property definitions. Use when you need to view all custom properties configured for organizations in the Help Scout account. |
list-saved-replies | Tool to list saved replies for a mailbox. Use when you need to retrieve all saved reply templates available in a specific mailbox. |
list-social-profiles | Tool to list all social profiles for a customer in Help Scout. |
list-tags | Tool to list all tags in Help Scout with pagination support. |
list-teams | Tool to list all teams in Help Scout with pagination support. |
list-threads | Tool to list all threads for a specific Help Scout conversation. |
list-users | Tool to list all users in the Help Scout account with optional filters for mailbox or email. |
list-users-status | Tool to list the status of all users including email and chat availability. |
list-webhooks | Tool to retrieve all webhooks configured in Help Scout. Use when you need to view all webhook subscriptions and their configurations. |
list-workflows | Tool to list all workflows (automation rules) in the account with optional filters for mailbox, type, and status. |
overwrite-customer | Tool to overwrite an existing customer in Help Scout, replacing all customer data. |
publish-thread-schedule | Tool to publish a scheduled thread immediately in a Help Scout conversation. |
remove-organization-property-value | Tool to remove an organization property value. Use when clearing the value of a custom property for a specific organization. |
run-manual-workflow | Tool to run a manual workflow on one or more conversations in Help Scout. |
set-organization-property-value | Tool to set or update a property value for a specific organization. |
set-user-status | Tool to set the status of a user in Help Scout. Use when you need to change a user’s availability to ‘active’ or ‘away’. |
update-chat-handle | Tool to update a chat handle for a Help Scout customer. Use when you need to modify an existing chat platform username (like Skype, AIM, Yahoo)… |
update-conversation | Tool to update specific properties of a Help Scout conversation using JSON Patch format. |
update-conversation-tags | Tool to update tags on a conversation in Help Scout. Use when you need to add, remove, or replace tags on a conversation. |
update-conversation-thread-schedule | Tool to update an existing schedule for a conversation thread in Help Scout. |
update-customer | Tool to update an existing customer in Help Scout using JSON Patch operations. |
update-customer-address | Tool to update an existing address for a Help Scout customer. |
update-customer-email | Tool to update an existing email for a customer in Help Scout. |
update-customer-phone | Tool to update an existing phone number for a Help Scout customer. |
update-customer-properties | Tool to update custom property values for a Help Scout customer using JSON Patch operations. |
update-customer-social-profile | Tool to update an existing social profile for a customer in Help Scout. |
update-customer-website | Tool to update an existing website URL for a customer in Help Scout. |
update-custom-fields | Tool to update custom fields on a Help Scout conversation. The complete fields list replaces existing data - omitted fields are removed. |
update-mailboxes-routing | Tool to update routing configuration for a mailbox inbox in Help Scout. |
update-organization | Tool to update an organization in Help Scout. Use when you need to modify organization details such as name, website, domains, or contact information. |
update-organization-property | Tool to update an organization property definition in Help Scout. |
update-organization-property-industry | Tool to update the industry organization property definition in Help Scout. |
update-saved-reply | Tool to update an existing saved reply in a Help Scout mailbox. |
update-snooze | Tool to update or set a snooze on a Help Scout conversation. |
update-thread | Tool to update a specific thread in a Help Scout conversation using JSON Patch format. |
update-webhook | Tool to update an existing webhook subscription in Help Scout. |
update-workflow-status | Tool to update the status of a Help Scout workflow (enable/disable automation rule). |