Ticket numbers, customer portals & robo-emails aren't a great way to build trust. Help Scout makes every customer interaction a personalized one.

50 subscribers
65 endpoints
The in-depth APIMemo review for this API hasn't been published yet — the data below comes straight from the public marketplace listing.

HelpDesk endpoints

MethodEndpointDescription
POST createCustomer
/createCustomer 		Create customer
POST createConversationThread
/createConversationThread 		Create conversation thread
POST createAttachment
/createAttachment 		Create Attachment
POST createConversation
/createConversation 		Create conversation object
POST createWebhook
/createWebhook 		Clients may create and configure up to one webhook per company. A webhook may be configured to receive multiple event notifications (e.g. conversation created, note added). Each…
POST deleteAttachment
/deleteAttachment 		Delete attachment
POST deleteConversation
/deleteConversation 		Delete conversation
POST deleteNote
/deleteNote 		Delete note
POST getAttachmentData
/getAttachmentData 		Return attachment data object.
POST getBusiestDayTimeReport
/getBusiestDayTimeReport 		The busiest time of day report provides a summary of which days and times had the highest coversation volume. Days/hours are reported using the company's time zone.
POST getCompanyDrillDownReport
/getCompanyDrillDownReport 		This report is similar to the Company Report, but instead of returning statistics about the company, it drills down and returns the conversation data that makes up the Company…
POST getCompanyOverallReport
/getCompanyOverallReport 		The company report provides statistics about your company performance over a given time range. You may optionally specify two time ranges to see how performance changed between…
POST getConversationsReport
/getConversationsReport 		The conversations report provides statistics about conversation volume over a given time range. You may optionally specify two time ranges to see how conversation volume changed…
POST getCurrentUser
/getCurrentUser 		Returns a current user
POST getCustomerMailboxConversations
/getCustomerMailboxConversations 		Return conversations for a specific customer in a mailbox.
POST getMailboxCustomers
/getMailboxCustomers 		Returns a list of Customers with conversations associated with the specified mailbox.
POST getCustomersHelpedReport
/getCustomersHelpedReport 		The customers helped report provides statistics about how many customers were helped over a given time range. You may optionally specify two time ranges to see how the number of…
POST getCustomersList
/getCustomersList 		Return list of mailbox customers. Customers can be filtered on any combination of first name, last name, email, and modifiedSince.
POST getDocsReport
/getDocsReport 		The Docs report provides statistics about Docs usage (searches, top articles, etc.) over a given time range. You may optionally specify two time ranges to see how usage changed…
POST getDrillDownReport
/getDrillDownReport 		This report is similar to the Conversations Report, but instead of returning statistics about conversation volume, it drills down and returns the conversation data that makes up…
POST getFieldDrillDownReport
/getFieldDrillDownReport 		This report is similar to the Conversations Report, but instead of returning statistics about conversation volume, it drills down and returns the conversation data (by…
POST getFirstResponseTimeReport
/getFirstResponseTimeReport 		This report provides average first response times for each period in a specified time range. You may optionally specify two time ranges to see how first response time changed…
POST getFolderMailboxConversations
/getFolderMailboxConversations 		Return conversations in a specific folder of a mailbox.
POST getHappinessOverallReport
/getHappinessOverallReport 		The happiness report provides information about how many Great, Okay, and Not Good ratings your company received for each period in a specified time range. You may optionally…
POST getHappinessRatingsReport
/getHappinessRatingsReport 		The happiness ratings report provides a company's ratings for over a specified time range.
POST getMailboxConversations
/getMailboxConversations 		Return conversations in a mailbox.
POST getMailboxFolders
/getMailboxFolders 		Returns a mailbox folders.
POST getMailboxList
/getMailboxList 		Return mailbox list.
POST getMailboxUsersList
/getMailboxUsersList 		Returns a mailbox users list
POST getNewConversationsReport
/getNewConversationsReport 		The new conversations report provides a summary of new conversation volume over a given time range.
POST getNewDrillDownReport
/getNewDrillDownReport 		This report is similar to the New Conversations Report, but instead of returning statistics about new conversation volume, it drills down and returns the actual new conversations…
POST getProductivityDrillDownReport
/getProductivityDrillDownReport 		This report is similar to the Productivity Report, but instead of returning statistics about productivity, it drills down and returns the conversation data that makes up the…
POST getProductivityOverallReport
/getProductivityOverallReport 		The productivity report provides a snapshot of productivity over a given time range. You may optionally specify two time ranges to see how productivity changed between the two…
POST getReceivedMessagesReport
/getReceivedMessagesReport 		The received messages report provides a summary of he volume of received messages over a given time range. Only messages from customers are counted.
POST getRepliesSentReport
/getRepliesSentReport 		This report provides the number of replies sent for each period in a specified time range. You may optionally specify two time ranges to see how the number of replies sent…
POST getResolutionTimeReport
/getResolutionTimeReport 		A variety of filters are available as query parameters. Including any of these will result in only conversations that match the filters being included in the report.
POST getResolvedReport
/getResolvedReport 		This report provides the number of resolved conversations for each period in a specified time range. You may optionally specify two time ranges to see how the number of resolved…
POST getResponseTimeReport
/getResponseTimeReport 		This report provides average response times for each period in a specified time range. You may optionally specify two time ranges to see how response time changed between the two…
POST getSingleConversation
/getSingleConversation 		Return a single conversation.
POST getSingleCustomer
/getSingleCustomer 		Returns a single customer object
POST getSingleMailbox
/getSingleMailbox 		Returns a mailbox object.
POST getSingleTeam
/getSingleTeam 		Returns a single team
POST getSingleUser
/getSingleUser 		Returns a single user
POST getTagsList
/getTagsList 		Returns a list of tags used across all mailboxes. Tags are returned in alphabetical order, A-Z.
POST getTeamMembers
/getTeamMembers 		Returns a team members
POST getTeamsList
/getTeamsList 		Returns a list of teams
POST getUserConversationHistoryReport
/getUserConversationHistoryReport 		The conversation history report provides details about a user's conversations for over a specified time range.
POST getUserCustomersHelpedReport
/getUserCustomersHelpedReport 		This reports provides the number of customers a user helped for each period in a specified time range. You may optionally specify two time ranges to see how the number of…
POST getUserHappinessReport
/getUserHappinessReport 		The happiness report provides information about how many Great, Okay, and Not Good ratings a user received for each period in a specified time range. You may optionally specify…
POST getUserMailboxConversations
/getUserMailboxConversations 		Return conversations assigned to a specific user in a mailbox.
+ 15 more endpoints on the provider's documentation.

HelpDesk pricing

PlanPriceRate limitQuotas
BASIC Free — —

More Business Software APIs

View all →

  • BIN/IP Checker

    Shield your business from fraud effortlessly with our powerful, free BIN lookup API. Prevent fraudulent…

    Business SoftwareFreemium15k subscribers

  • Find any IP address or Domain Location world wide

    Free IP Geo Location API with 100% accurate geo information of IP address or Domain name like city latitude,…

    Business SoftwareFreemium2.3k subscribers

  • yakpdf - HTML to PDF

    HTML/URL to PDF converter. Stop yak-shaving, generate a PDF now! https://yakpdf.com

    Business SoftwareFreemium1.4k subscribers

  • 3DS LOOKUP

    BIN/IIN LOOKUP Check the security of payment cards and determine if they have bank protection. Our service…

    Business SoftwareFreemium864 subscribers

  • TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed

    reverse engineered TikTok mobile API covered non-autorized actions

    Business SoftwareFree1.3k subscribers

  • API Element Envato Downloader

    Powerful REST API for downloading premium assets from Envato Elements automatically. Integrate fast, secure,…

    Business SoftwareFreemium28 subscribers