API Clients

We maintain two official API clients and encourage developer-built API clients as well.

Official Help Scout Clients

Open source clients for Python, Ruby, Node.js and more are listed on the open source page.

AngularJS

While not a true API client, this is an example of communicating with the API via JavaScript:

<html>
<head>
<meta charset=utf-8 />
<script src="https://javascriptbase64.googlecode.com/files/base64.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.2.19/angular.js"></script>
</head>
<body ng-controller=main>
<form ng-submit="init()">
<label>Help Scout API Key: <input type=text ng-model=api_key name=api_key></label>
<input type=submit id=submit value=Submit>
</form>
<script>
angular.module('helpscout_web_app',[]).controller('main',['$scope','$http',
function($scope,$http) {
	$scope.init=function() {
		console.log('Request sent, loading response...');
		var show_stuff=function(data) {
			console.log(data);
			console.log('Response from Help Scout received.');
		}
		var api_auth='Basic '+Base64.encode($scope.api_key+':X');
		$http.get('https://api.helpscout.net/v1/mailboxes.json', {
			headers:{
				'Authorization':api_auth,
				'Content-Type':'application/x-www-form-urlencoded'
			}
		}).success(show_stuff);
	}
}]);
angular.element(document).ready(
	function() {
		angular.bootstrap(document,['helpscout_web_app']);
	}
);
</script>
</body>
</html>