Getting started with the Teamwork Desk API

Welcome to the Teamwork Desk API. First things first, authentication is necessary for every request when using the Teamwork Desk API.

If you are using the API for personal use, or to do some testing, Bearer token Auth with API KEY will work.

If you are developing an application or integration for others to use, you should utilise our App Login Flow which implements OAuth 2.0.

We advise making all calls to your Teamwork account over SSL. If you have any security concerns or questions just drop us an email to security@teamwork.com.

Regardless of the chosen authentication method, you and your application's users will only have access and permission to the information that is accessible through their profile in Teamwork Desk.

To get started, you will need your API key and your site URL to start using the API.

Getting Your URL

  1. Open Teamwork Desk.

  2. Copy the URL from your address bar (ignoring /desk...). This should be something like https://{{yourSiteName}}.teamwork.com. If you're using a custom domain, it might be something like https://support.example.com.

All endpoints will start with https://{{yourSiteName}}.teamwork.com/desk/api/v2/.

US Hosted customers: https://{yourSiteName}.teamwork.com

EU Hosted Customers: https://{yourSiteName}.eu.teamwork.com

Getting an API Key

  1. In Teamwork Desk, click your avatar in the bottom left.

  2. Click "View Profile".

  3. Go to "API Keys".

  4. At the top right of this screen, select "create an API key".

  5. Copy the "Key".

Who has Teamwork Desk API access

Any user with an active seat in Teamwork Desk can access the API. Access to data with the API is based on the users permissions and the features available with the subscription plan.

Endpoints documentation

The complete list of available endpoints is available in the api reference documentation.

Feedback

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