Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

teamwork-api

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

teamwork-api

A wrapper around teamwork api making it easier to perform requests.

  • 1.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Teamwork Api

A wrapper around teamwork api making it easier to perform requests.

Travis Version Licence

Installation

$ npm install teamwork-api

Getting Started

The api key and sub-domain are required to connect to teamwork's api, provide these as environment variables like so:

process.env.TW_API = '1234567890'
process.env.TW_SUB = 'subdomain'

const tw = require('teamwork-api')()

Alternatively pass them in as function arguments

const tw = require('teamwork-api')('1234567890', 'subdomain')

If your teamwork installation uses a custom domain (ie. https://tw.mycompany.com) pass the custom_domain=true flag.

const tw = require('teamwork-api')('1234567890', 'https://tw.mycompany.com', custom_domain=true)

Contributing

I am happy for people to contribute to this project, fix or add new features.

Be sure when adding / modifying methods that the doc blocks are correct.

The documentation is built based on these comments using npm run docs.

Further to this ensure when you commit you are using npm run commit as this will help when semantic versioning the code.

Happy coding 💻...

API Reference

Account

Activity

Invoices

Expenses

Boards

Message Categories

File Categories

Notebook Categories

Link Categories

Clock In / Clock Out

Project Categories

Comments

Calendar Events

Companies

Files

Messages

Milestones

Notebooks

People

Status

Projects

Links

Risks

Time

Task Lists

Tasks

Task Reminders

Tags

Webhooks

Workload

Trashcan

Keywords

FAQs

Package last updated on 04 Nov 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc