Getting started with the Teamwork Desk API

Hey 😀. First things first, 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://{{YOUR_SITE}} If you’re using a custom domain, it might be something like

All endpoints will start with https://{{YOUR_SITE}}

Getting an API key

  1. In Teamwork Desk, click your avatar in the top right.
  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”.


For all requests to our API, send the API key in the Authorization header; e.g. Authorization: Bearer {{YOUR_API_KEY}}. Example using Curl:

curl -i https://{{YOUR_SITE}} -H "Authorization: Bearer {{YOUR_API_KEY}}"

Also see Third-party app login flow if you’re building an app.

Endpoints documentation

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


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