API Reference
This API Reference lists all entities and operations supported by the awork API.
How to use the API Reference
The endpoints are grouped by feature area. At the beginning of each section there is an introduction to the general concepts that are important to understand when working with these endpoints. Each endpoint includes a brief description of the resource, the operations supported, and the request and response formats as well as example values.
If you have any questions or need help, please contact us in the Developer Forum.
Main Feature Areas
These are the main feature areas in awork and the corresponding API endpoints:
Projects are the core entity in awork and represent a collection of tasks and other resources.
Tasks are the smallest unit of work in awork and represent work to be done.
Time Tracking and the resulting Time Entries allow projects to be billed.
Projects are usually connected to Companies (Clients).
Users, Teams and Roles form the basis of awork’s permission management.
Workload, commited work and user capacities help with Project Planning.
API v1
This is the first and default version of the awork API. It is a RESTful API that uses JSON for serialization and OAuth 2.0 for authentication. The API is designed to be easy to use and to provide a consistent interface for all clients.