Awork SDK

An (almost) complete JavaScript API wrapper for project management software Awork. The goal of this project is to provide a comprehensive set of tools to interact with the Awork REST API when working with JavaScript. This library can be imported as a CommonJS or ES module and supports autocompletion via .d.ts files.

Please be aware: Awork is a product of awork GmbH. This project is maintained by Brand Boosting GmbH and is not endorsed by awork GmbH in any way.

Resources:

• Awork SDK Reference (every endpoint in detail)

• The Awork Developer Portal

Found a bug?

This library is quite new and there may be bugs. Please open an issue if you think you encountered a bug.

ToDos

We are trying to maintain this project as actively as possible. Please open an issue if you have a specific feature request.

• [ ] Documenting the OAuthClient and OAuthServer Class
• [ ] EasyOAuth Service for serverless applications
• [ ] Migrate to TypeScript
• [ ] Write actually useful tests
• [ ] Write Reference Home Page

Installation:

Usage:

Most endpoints include the CRUD operations (get, list, create, update and delete). Sometimes there are additional business operations. (setArchived, removeProjectMember, addTags) Nested endpoints can be chained. (eg. awork.projects.files(YOUR_PROJECT_ID).list())

Get a specific project

Get a list of teams

Create a new user

Update a specific task

Delete a company

Add tag to specific task

Create TaskList inside specific project

Pagination and filtering

Acknowledgements

Thanks to Nils Czernig at Awork for providing us with an unlimited demo workspace.