Getting Started with the Teamwork API

Welcome to the Teamwork API. First things first, you’ll need to get authenticated.

To make simple API calls, or do some testing, Basic Auth will work, take a look at our start up tutorial. Follow the steps here to get your API key.

If you are building an App or Integration, we recommend you use our App Login Flow which implements OAuth 2.0. You’ll need to register your app or integration on our new Developer Portal. It’s quick to set up, and allows you full control of your credentials.

Once you are authenticated your all set! You can send requests to the API now. You can send GET/POST/PUT/DELETE calls.

For example, you can get all tasks across all projects. With GET requests, you will get a status 200 back along with the objects you requested. Take a look here.

A simple example of a POST to use as reference would be creating a task. Take a look here and this will show you a simple POST request. You can see the url, the post call, and the body parameters to be passed in. Usually if your missing a required parameter it will let you know, so just test out your data request to get it right. For POST requests, you should receive a status 201.

Feedback

If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.