API guides

We've curated a selection of useful guides to help you understand and use the API's effectively.

If you need further support please get in touch with our team.


import http.client

conn = http.client.HTTPSConnection("{yourSiteName}")
payload = ''
headers = {
  'access-control-expose-headers': 'id,x-page',
  'Authorization': 'Basic '+base64.b64encoded('userName:password')
conn.request("GET", "/projects/api/v3/tasks.json", payload, headers)
res = conn.getresponse()
data =

API guides

Get started with the API for project management.

Read more

Teamwork Desk

Get started with the Teamwork Desk API for client communication.

Read more

Teamwork Spaces

Get started with the Teamwork Spaces API for content management.

Read more

Teamwork Chat (Incoming Hooks)

Post data to Chat using the Incoming Hooks feature

Read more

Example requests

Learn how to use the code sample feature in API endpoint documents

Sparse Fieldsets

Learn about Sparse Fieldsets and how to implement them from API V3.

Custom Fields

Learn how to add extra data to your projects and tasks using custom fields.


Learn about the 3 different headers associated with paging for the API.