Skip to main content

Help Scout

Integrating Help Scout with Osano​

Connecting to Help Scout​

In order for Osano to discover data stored in your systems, we must connect to those data providers via an API. We require, at minimum, read-only access to establish a connection to these providers. Each provider you connect may require different information. Please see the linked vendor documentation for instructions on where and how to obtain this data.

Required Fields​

  • One-click Authentication - Log into your admin-level account via the Osano portal to grant access to Help Scout.

Base URL​

https://api.helpscout.net/v2

Auth​

  • API Key
  • OAuth

Authorization header with bearer token

Core Functionality​

  • Data Discovery
  • User Search
  • Data Deletion
  • Email
  • Name
  • Phone Number
  • Address
  • Date of Birth
  • User ID

Endpoints​

Used for data discovery

  • GET customers
  • GET conversations?status=all
  • GET conversations/:conversationId/threads
  • GET users

Used for user search

  • GET customers?query=(email:"$email")
  • GET conversations?query=(customerEmail:"$email")&status=all
  • GET conversations/:conversationId/threads
  • GET users?email=$email