Developers

Build applications, mash-ups using the powerful Huddle developer API.

Build applications, mash-ups using the powerful Huddle developer API.

API FAQ

What formats does your API support?

The Huddle API is a simple HTTP service secured via SSL. XML and JSON are supported as request and response formats. The format used is specified in the path of the API endpoint; to use JSON the path should start with /v1/json/; to use XML the path should start with /v1/xml/.

How does authentication work?

All API requests require authentication. We use standard HTTP Basic Authentication where email address (or Huddle username) and password are sent as base 64 encoded clear text. All API calls are protected by SSL so that your details remain secure.

HTTP header example:

GET /v1/json/files/12345 HTTP/1.1
Host: api.huddle.dev
Authorization: Basic dXNlcjpwYXNz
What functionality does your API currently support?

The API currently provides methods to work with files, tasks and discussions, as well as workspaces and newsfeeds. See the API documentation for the full list. We’re constantly adding new methods so check back often.

Are there any legal things to be aware of?

Use of the Huddle API is governed by section 6 of our Terms of use.

Quick reference
get.tasks
Gets a list of tasks. If you do not specify a workspace Id it will return the authenticated users tasks.
get.files.and.folders.for.folder
Gets the list of Files and Folders in a Folder. This method is not recursive, you have to call get.files.for.folder to get Files contained in a sub Folder
upload.file
Upload a file to a specified folder. You can notify existing huddle users that the file is uploaded by populating the userstonotify form field.
get.news
Gets the “what’s new” feed for all the user’s workspaces.

See Api Documentation