Teamwork Projects API Client

Simple API client for Teamwork Projects based on the published API docs.

This project is in no way affiliated with the company Teamwork. It only serves as a NodeJS API client.

Installation

npm install --save teamwork-projects-api-client

Usage

General

const teamwork = new Teamwork({
  urlPrefix: 'my-company',
  region: 'eu',
  apiKey: 'superSecretApiKey',
});


teamwork.Projects.create({
  name: 'My Project',
  descriptio: 'My super awesome project',
  companyId: '999',
});

Endpoints

• Projects
• Task Lists
• Invoices

Projects

list

const response = await teamwork.Projects.list(qs);

qs can be and of the query string parameters found in the API documentation.

response will be the projects array key documented in the API response.

fetch

const response = await teamwork.Projects.fetch(id, options);

options can be any of the path or query string parameters found in the API documentation.

response will be the project key of the documented API response.

listInCompany

const response = await teamwork.Projects.listInCompany(companyId, qs);

companyId must be the ID of a company in your Teamwork account.

qs can be any of the query string parameters found in the API documentation.

response will be the projects array key documented in the API response.

listStarred

const response = await teamwork.Projects.listStarred();

response will be the projects array key documented in the API response.

getRates

const response = await teamwork.Projects.getRates(id, qs);

id must ba a valid project ID.

qs can be any of the query string parameters found in the API documentation.

response will be the rates key documented in the API response.

getStats

const responspe = await teamwork.Projects.getStats(id, qs);

id must ba a valid project ID.

qs can be any of the query string parameters found in the API documentation.

response will be the rates key documented in the API response.

create

const response = await teamwork.Projects.create(options);

options can be any of the keys from the project request object found in the API documentation.

response will be an object with an id key for the created project ID.

setRates

const response = await teamwork.Projects.setRates(id, rates);

id must be a valid project ID.

rates can be and of the keys from the rates request object found in the API documentation.

response will be an empty object on success.

update

const response = await teamwork.Projects.update(id, options);

options can be any of the keys from the project request object found in the API documentation.

response will be an empty object on success.

toggleFeatures

const response = await teamwork.Projects.toggleFeatures(id, options);

id must be a valid project ID.

options can contain any of the keys from the project request object found in the API documentation.

response will be an empty object on success.

star

const response = await teamwork.Projects.star(id);

id must be a valid project ID.

response will be an empty object on success.

unstar

const response = await teamwork.Projects.unstar(id);

id must be a valid project ID.

response will be an empty object on success.

delete

const response = await teamwork.Projects.delete(id);

id must be a valid project ID.

response will be an empty object on success.

Task Lists

Invoices