Getting Started with the API

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

If you are using the API for personal use, or to do some testing, Basic Auth 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

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

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

  1. Open

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

US Hosted customers: https://{yourSiteName}

EU Hosted Customers: https://{yourSiteName}

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

  2. Click "Edit my details".

  3. Go to "API & Mobile".

  4. Click on the "Show your token".

  5. Copy the "Key".

Any user (including Client users and collaborators) with an active seat in can access the API. Access to data with the API is based on the users permissions and the features available with the subscription plan.


If you have any feedback or suggestions, feel free to contact us at