Add support for QUERY HTTP method for batch fetch requests (not documented, yet)
Deprecations
HTTP method POST is deprecated for all API endpoints that fetch data. Use the new QUERY method instead.
04.258.000 - 21.07.2026
Deprecations
Property groupType on groups is deprecated. The agile group types (sprint/backlog) have been removed; it now always returns group and is ignored on patch. It will be removed in a future version.
04.248.000 - 17.06.2026
Property controlling.progressAnalysis.earnedValue added to projects and groups.
04.244.000 - 26.05.2026
Route Users > Users > Get users added.
Route Users > User groups > Get groups added.
Deprecations
Route Users > Users > Gets emails by user ids is deprecated, use Get users instead.
04.222.000 - 17.03.2026
Property billingType on work packages received a new additional enum value effortTarget.
Property defaultBillingType on customers received a new additional enum value effortTarget.
04.216.000 - 10.02.2026
Property avatar added to Current user > Who am Iuser.
Deprecations
Property avatarUrl in Current user > Who am Iuser is deprecated, use avatar.url instead.
04.214.000 - 27.01.2026
Property minMaxPlanningDate added to work packages.
04.211.000 - 13.01.2026
Property customer added to projects.
Deprecations
Property flowCustomer on projects is deprecated, use customer instead.
Property flowCustomer on groups is deprecated, use the project's customer instead.
Property flowCustomer on work packages is deprecated, use the project's customer instead.
04.208.000 - 16.12.2025
Property originalDueDate added to projects and groups.
04.183.000 - 16.09.2025
Breaking changes
Property timeTrackingReferenceNodeType removed from work packages.
API for sub work packages completely removed
04.161.000 - 16.06.2025
Property controlling.tasks.progress added to projects and groups.
Property controlling.workPackages.progress added to projects and groups.
04.155.000 - 20.05.2025
Property isCompleted added to tasks.
Search ident isCompleted added to tasks.
Deprecations
Property status on tasks is deprecated, use isCompleted instead.
Search ident status for task searches is deprecated, use isCompleted instead.
04.154.000 - 13.05.2025
Property pricingSnapshot added to billings.
Deprecations
Property flatRateJourneyPrice on billings is deprecated, use pricingSnapshot.flatRateJourneyPrice instead.
Property journeyBillingMode on billings is deprecated, use pricingSnapshot.journeyBillingMode instead.
Property sums on billings is deprecated, use pricingSnapshot.sums instead.
04.148.000 - 01.04.2025
Property minMaxPlanningDateInSubtree added to projects.
Property minMaxPlanningDateInSubtree added to groups.
Breaking changes
API authentication via OAuth2 has been removed.
Property lastChanged on nodes has been removed.
Property status on projects has been removed.
Property status on work packages has been removed.
Search ident status for work package searches has been removed.
Property roleMaxEfforts on work packages has been removed.
Query parameter roleType on route Responsibility > Responsible users > Get responsible users for multiple nodes has been removed.
These routes have been removed:
Working time > Read working time > Get definitions
Working time > Read working time > Get work hours
Working time > Manage weekly working time > Group standard work hours
Working time > Manage weekly working time > Group standard work minutes
Working time > Manage weekly working time > User standard work hours
Working time > Manage weekly working time > User standard work minutes
04.138.000 - 25.02.2025
Route Users > Users > Gets emails by user ids also includes invited users now.
04.134.000 - 11.02.2025
Documentation updated to OpenAPI 3.1.0.
Category Customers renamed to Settings.
REST routes Settings > Labels added.
In category Project tree:
REST GET-routes have their properties set to required appropriately.
REST routes for Task sections added.
Route General > Gets nodes by ids added.
Route General > Gets node by id added.
Route General > Simple search added.
Route General > Complex search added.
Route General > Complex search added.
Property projectId added to tasks and task sections.
Route Users > Current user > Who am I added.
04.114.000 - 22.10.2024
Property workflowStatus added to billings.
04.095.000 - 03.09.2024
Breaking changes
Property assignedUnits on tasks removed, use responsibleUsers/responsibleGroups instead.
Property hasExternalAssignee on tasks removed, you can set definesOwnResponsible with empty users/groups to have the same effect.
04.094.000 - 27.08.2024
API access via access keys and access tokens added.
Deprecations
API access via OAuth2 is deprecated, use access keys or access tokens instead.
04.086.000 - 09.07.2024
Property user added to TIME TRACKING > Time tracking records > Patch time tracking record.
04.085.000 - 09.07.2024
Property isClosed added to projects.
Property isClosed added to groups.
Property isClosed added to work packages.
04.083.000 - 25.06.2024
Property journeyBillingMode added to customer.
Property journeyBillingMode added to billing.
Property flatRateJourneyPriceSum added to billing $.sums.
Property numberOfFlatRateJourneys added to billing $.sums.
Route Billings > Billings exports > JSON export v1 is deprecated, use JSON export v2.
Breaking changes
The columns of Billings > Billings exports > CSV export are reorganized to match JSON export v2.
04.074.000 - 22.05.2024
Property timeTrackingReferenceNodeType added to work packages.
Route category Project tree > Sub work packages added.
04.072.000 - 21.05.2024
Property timeControl added to work packages.
Property lastChangedBy added to all nodes.
Property lastChangedOn added to all nodes.
Deprecations
Property lastChanged on nodes is deprecated, use lastChangedOn instead.
Breaking changes
The time control properties on projects and groups have been dropped in favor of a nested object:
Property timeControl is an object now, use timeControl.mode instead.
Property timeControlFrom removed, use timeControl.from instead.
Property timeControlTo removed, use timeControl.to instead.
Property showTimeControlAfterName removed, use timeControl.showAfterName instead.
04.064.000 - 16.04.2024
Route Users > Users > Gets emails by user ids no longer requires ids as query parameter.
Property isArchived added to all project tree nodes (readonly).
Property isLocked added to projects, groups, work packages (prevents tracking time on those nodes or beneath).
Property isApprovedForBilling added to work packages.
Property isOffer added to work packages.
Property isTemplate added to projects.
Property referenceNode added to time tracking records.
New route Project tree > General > Archive subtree added to archive or unarchive an entire subtree of nodes.
Deprecations
Property status on projects is deprecated.
Use the new isLocked/isTemplate flags or the new archiving route for writing.
When read, the status is determined by the new flags in this order of precedence:
isArchived > isTemplate > isLocked to yield archived > template > locked > open respectively.
Note that writing {status: 'archived'} will archive the entire subtree. Writing any other status will unarchive the entire subtree only of the project was archived before.
Property status on work packages is deprecated.
Use the new isApprovedForBilling/isLocked/isOffer flags or the new archiving route for writing.
When read, the status is determined by the new flags in this order of precedence:
isApprovedForBilling > isOffer > isLocked to yield closed > offer > locked > open respectively.
The status notYetOpen will write {isLocked: true} and can't be read anymore.
Search ident status for work package searches is deprecated, use one of the new flag searches.
04.058.000 - 12.03.2024
Property locations added to customers.
Property keyValueStore added to all project tree nodes.
Property referenceNumber added to all project tree nodes.
04.036.000 - 19.12.2023
Properties definesOwnResponsible/responsibleGroups/responsibleUsers are added to projects, groups, work packages and tasks.
Deprecations
Property assignedUnits on tasks is deprecated, use responsibleUsers/responsibleGroups instead.
Property hasExternalAssignee on tasks is deprecated, you can set definesOwnResponsible with empty users/groups to have the same effect.
Property roleMaxEfforts on work packages is deprecated without replacement. The feature is removed.
Query parameter roleType on route Responsibility > Responsible users > Get responsible users for multiple nodes is deprecated without replacement. The feature is removed.
04.021.000 - 03.11.2023
Deprecations
The working time API is updated to differentiate working time from project time:
Using hours or minutes is deprecated, use workingMinutes and projectMinutes instead where applicable.
These routes are deprecated entirely (see documentation for replacements):
Working time > Read working time > Get definitions
Working time > Read working time > Get work hours
Working time > Manage weekly working time > Group standard work hours
Working time > Manage weekly working time > Group standard work minutes
Working time > Manage weekly working time > User standard work hours
Working time > Manage weekly working time > User standard work minutes