Help Scout

CommunicationOAuth 2.0Client credentials

Read, create and reply to conversations, add notes and tags, and manage customers in Help Scout mailboxes.

12 actions

ActionEffectData handledScope
help_scout_list_conversationsLists conversations filtered by mailbox, status, tag, assignee or a search query, 25 per page, newest activity first by defaultreadPersonal data
help_scout_get_conversationReturns a conversation with its customer, status, tags and assignee, and its threads (messages and notes) when embed is threadsreadPersonal data
help_scout_create_conversationCreates a conversation in a mailbox with a first customer message, or an outgoing reply to send the customerwritePersonal data
help_scout_reply_to_conversationSends a reply to the customer on a conversation, or saves it as a draft, optionally changing the statuswritePersonal data
help_scout_add_noteAdds an internal note to a conversation, visible only to the teamwritePersonal data
help_scout_update_conversation_statusChanges a conversation's status, such as closing it or marking it pendingwriteGeneral
help_scout_set_conversation_tagsReplaces a conversation's tags with the given list; an empty list removes them allwriteGeneral
help_scout_list_customersLists customers, optionally matched by a search query such as (email:"ada@example.com") or by first and last namereadPersonal data
help_scout_get_customerReturns a customer with their emails, phones, organization and other profile detailsreadPersonal data
help_scout_create_customerCreates a customer profile with a name, email and optional job title and organizationwritePersonal data
help_scout_list_mailboxesLists the mailboxes the user can access, with their ids, names and emailsreadGeneral
help_scout_list_usersLists the account's users, optionally only those with access to a mailboxreadPersonal data