Getting started with the Teamwork CRM 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 CRM.
  2. Copy the URL from your address bar (ignoring /crm...). This should be something like https://example.teamwork.com. If you’re using a custom domain, it might be something like https://projects.example.com.

Almost all endpoints will start with https://example.teamwork.com/crm/api/v2/.

Getting an API key

  1. In Teamwork CRM, click your avatar in the top right.
  2. Click “Settings”.
  3. Go to “Personal”.
  4. At the bottom of this screen, generate an API key.
  5. Copy the “Key”.

Authenticating

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://example.teamwork.com/crm/api/v2/deals.json -H "Authorization: Bearer skdfjnsdjkfndskujfbsdjkbfsdk"

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.

Feedback

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