Changelog
This page contains a list of past and upcoming changes to the awork API. We always try our best to prevent breaking changes, but sometimes we can’t avoid making some changes in order to release a new awesome feature. 🚀
Subscribe to API updates and other developer news.
Upcoming changes
This section shows upcoming changes.
Recent changes
This section shows you recent changes that are already live in our API.
New: Custom Fields 🚀
Custom fields is one of the most highly requested features in awork. They allow users to add custom properties to tasks via projects and project templates. Custom fields can be of different types, such as text, number, date, and more.
They are also a great way to store additional information in tasks, such as an external Id, which makes it a lot easier to integrate awork with other tools via the API.
See the Custom Fields Overview & API Reference for more information.
Domain changed to awork.com: clients need to update URLs 🚨
We have recently switched our primary domain from awork.io to awork.com. The application and website remain available at both domains for the time being, however, by end of December 2023, clients must have updated to awork.com to continue using the awork API.
Projects, Tasks and Users: Key and NumberCount properties removed 🚨
The Key property of Projects, Tasks and Users as well as the NumberCount property of Tasks have been removed. These properties were never used in the awork web app, so we’re removing them from the API models as well.
These changes are happening in the API on 26.05.2023 in the evening.
Tasks: EntityId is deprecated 🚨
The EntityId in the Task model is deprecated and will be removed in the future. Use UserId for private tasks and ProjectId for project tasks instead.
These changes are happening in the API on 05.05.2023 in the evening.
Tasks: several nested fields removed 🚨
The following nested fields have been removed from the model for performance reasons:
These changes are happening in the API on 05.05.2023 in the evening.
Subtasks become Checklists 🚨
We are adding a new feature called Subtasks, therefore we are renaming the currently existing Subtasks to Checklists. The new Subtasks will be more powerful and bring a new level of planning to awork.
In the following endpoints, subtasks will be renamed to checklists. The functionality remains the same.
This change is happening in the API on 03.03.2023 in the evening.
API Rate Limits for API clients 🚨
We are introducing API rate limits that will limit the number of requests external API clients can make to a workspace. These limits depend on the plan of the workspace. The limits are shared by all external client applications across the workspace. Please see Rate Limits for details.
This change is happening in the API on 03.03.2023 in the evening.
Workload calculation - Single user calculation removal 🚨
We are deprecating the endpoint
GET /users/{userId}/workload
in favour of the new one:
GET /users/workload
This new endpoint will provide multiple user results in a single request, plus it has the option to fetch the details of the workload calculation.
The legacy endpoint will still be active up to 01.01.2023.
Then it will be removed.
Project Member Capacity - Endpoints removal 🚨
With the introduction of the project time bookings, we are migrating all the project member capacities to them.
As such, all the related endpoints are being deprecated and will not have any meaningful effect on the workload calculations:
GET /projects/{projectId}/members/{projectMemberId}/capacityPUT /projects/{projectId}/members/{projectMemberId}/capacityGET /projects/{projectId}/members/capacities
We will remove those endpoints and the related data starting from 01.01.2023
User Capacity - Property Removed New Endpoint 🚨
The User model currently has a CapacityPerWeek property, which we’re removing soon. This property is getting it’s own endpoint: /users/{userId}/capacity
This endpoint has GET and PUT methods to retrieve and edit the user’s weekly capacity. The GET model looks like this:
For a short time, both the property and the new endpoints will exist in parallel to be backward-compatible. We will remove the old property starting in March 2022. Please update your API client accordingly.
Project Templates - Auto Billability 🚨
Currently, projects have one property called IsBillableByDefault ,which decides whether time entries created on that project are marked as billable or not. This is either set by the project template, or if no project template was used for creation, by whether the project has a company or not. In the case of a company, the times are marked as billed, otherwise the times are marked as not billable.
The problem is, that the project template always overrules this company rule. We need to have more flexibility here, so we change the IsBillableByDefault property on the project template from a boolean to a string field with the possible values: on, off, auto.
When the auto option is set, the IsBillableByDefault of the project on project creation will be set according to the company rule, so true if a company is set and false if no company is set.
Multi-User Assignment - 18.09.21 🚨
This release adds the highly requested feature to assign multiple users to the same task. As a result, we reworked the endpoints that allow assigning multiple users to tasks and task templates as well as automations.
If you want to use this feature, please enable the task setting “Allow multi-user assignment” in awork in the workspace settings page. Alternatively, you can activate the setting by calling the tasks/settings endpoint from below with the setting name allow-multi-user-assignment.
Older Changes
Older changes can be found in the release articles on our roadmap https://www.awork.com/roadmap/ 🕵🏻♂️