API FAQ

WHAT DO I NEED TO KNOW BEFORE I START?

The Huddle API is built using HTTP standards. Developers should familiarize themselves with these standards and concepts before developing against the Huddle APIs.

Our reference point for the HTTP interactions is the httpbis working group with particular reference to the sections on messages and semantics.

HOW DOES AUTHENTICATION WORK?

Huddle use OAuth 2 for authentication on their APIs. Full documentation on the OAuth flow and details on getting an API token are available on our documentation on integrating using OAuth.

All API examples assume that you have already been issued an API token from the OAuth server. Once you have received a token, you can use it by placing it in the header as follows:

GET /someresource HTTP/1.1
Authorization: OAuth2 some-long-token-string

If the token is not present, is malformed, or has expired, you will receive a 401 not authenticated error. For information on refreshing your token or retrieving a new token, see the documentation on integrating using OAuth.

HOW DO I GET ACCESS TO THE HUDDLE API?

Before accessing Huddle APIs, you need to register your application. Please supply the following information to help@huddle.com  

• Application name
• Company (if appropriate)
• Contact name, phone and address
• Contact email
• Redirect URI (see here)
• Is this a web application, a desktop application, or an application running on a device?
• Short description of your application

You should receive a confirmation of receipt of your request within one business day. We aim to process all requests within three business days.

WHAT FUNCTIONALITY DOES YOUR API CURRENTLY SUPPORT?

The Huddle API currently provides extensive methods to work with files and folders, tasks, comments and people. We also provide a Changes API to allow you to efficiently query modifications to an object and its children.

See the API documentation for the full list. We’re constantly adding new methods so check back often.

As part of our continued efforts to conform with the latest industry-wide best practices in Internet security, we no longer support TLS 1.0 encryption protocol. Huddle only supports TLS 1.2. For more information, please visit our update on Huddle Help.