Menu

Samenvatting van de OpenProject API

Met de OpenProject APIv3 bouw je integraties die werkpakketten, planningen, meetings en tijdregistratie synchroon houden tussen OpenProject en je BI-, CRM- of helpdesk-stack. De hypermedia-API met HAL+JSON-responses maakt elk resource-type atomair aanspreekbaar, inclusief sub-resources zoals attachments, watchers, relations en revisions.
  • Werkpakketten en planning: Volledige CRUD op werkpakketten, sub-tasks, relations, watchers, attachments en revisies plus query-filtering voor Gantt- en Kanban-boards.
  • Project- en portfoliomanagement: Beheer projects, portfolios, programs, versies, sprints en categorieën inclusief project-copy, status en custom phases.
  • Meetings en samenwerking: Plan eenmalige en recurring meetings met agenda items, sections en notulen plus comments en emoji-reactions op activiteiten.
  • Tijdregistratie en werkschemas: Registreer time entries per project en activity, beheer working hours en non-working times per gebruiker en koppel met salarisadministratie.
  • File-storages en integraties: Verbind met Nextcloud, OneDrive en Google Drive via storages en file-links plus notificaties bij wijzigingen.
API Quick Facts REST
  • Authenticatie OAuth2, API Key, Basic Auth
  • Methods GET (171)PATCH (31)POST (71)DELETE (29)
  • Rate limits Niet gespecificeerd
  • Webhooks Niet beschikbaar
  • Sandbox Beschikbaar
  • Response format JSON
  • Versionering URL-based
  • SDK's Python

Laatste ontwikkelingen bij de OpenProject API

OpenProject ontstond in 2012 als fork van Redmine en kreeg een eerste APIv1 voor work-package- en projectbeheer. In 2014 lanceerde het team APIv3, een hypermedia-API op basis van HAL+JSON met OAuth 2.0 en API-key-authenticatie. In de jaren daarna is de API uitgebreid met meetings, recurring meetings, file-storages (Nextcloud, OneDrive/SharePoint, Google Drive), tijdregistratie, queries, grids en notificaties. In 2023 kwamen werkschemas, custom hierarchies en reminders erbij. De volledige OpenAPI 3.1-spec is publiek beschikbaar op GitHub onder de OpenProject-organisatie en wordt bij elke release bijgewerkt.

API versies

17.3.1
1 april 2026

Patch-release met bugfixes en stabiliteitsverbeteringen voor meetings, queries en storages.

17.0.0 Major release
1 oktober 2025

Major release met workspaces als nieuwe groeperingseenheid bovenop projects, plus uitgebreidere portfolio- en programma-endpoints.

Recurring meetings Major release
1 september 2024

Recurring meetings endpoints toegevoegd met occurrences, instantiate en cancel-operaties.

Reminders & notificaties Major release
1 november 2023

Reminders, notificatie-endpoints (read/unread), emoji-reactions en custom-field-hierarchies geïntroduceerd.

File storages Major release
1 april 2022

File-link en storages endpoints toegevoegd voor integratie met Nextcloud, OneDrive/SharePoint en Google Drive.

Working schedule
1 januari 2022

Days-, working-hours- en non-working-times-endpoints toegevoegd voor flexibele werkschema's per gebruiker.

APIv3 stable Major release
1 januari 2014

Lancering van APIv3 als hypermedia REST API op basis van HAL+JSON, opvolger van APIv1 en APIv2.