Authentication
For all requests to our API with Basic, first add the Basic word followed by a space and a base64-encoded string
{API_KEY or username}:password
in the Authorization
header.
Note: Because base64 is easily decoded, Basic authentication should only be used together with other security mechanisms such as HTTPS/SSL.
Get all projects example using Curl:
curl -i https://{yourSiteName}.teamwork.com/projects/api/v3/projects.json -H "Authorization: Basic skdfjnsdjkfndskujfbsdjkbfsdk"
In order to use OAuth 2.0, you will need to register your app using our Developer Portal. Here you can generate client ID and secret in order to implement App Login Flow.
Once you successfully implement OAuth 2.0 using the app details from our Developer Portal, you can simply make requests using the Authorization
header, but using a bearer token rather than passing in your API key with basic authentication.
Remember to include the token in the Authorization
header of your API requests.
For all requests to our API with OAuth 2.0, send the token in the Authorization
header;
e.g. Authorization: Bearer {token}
. Get all tasks example using Curl:
curl -i https://{yourSiteName}.teamwork.com/projects/api/v3/tasks.json -H "Authorization: Bearer {token}"
Feedback
If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.