OpenProject Groups API
Groups are collections of users. They support assigning/unassigning multiple users to/from a project in one operation.This resource does not yet have the form and schema endpoints. But as all properties are static, clients should still be ableto work with this resource.## Actions## Actions| Link | Description | Condition ||:-------------------:| -------------------------------------------------------------------- | ---------------------------------------------------------------- || delete | Deletes the group. | **Permission**: Administrator || updateImmediately | Updates the group's attributes. | **Permission**: Administrator |## Linked Properties| Link | Description | Type | Constraints | Supported operations | Condition ||:-----------: |-------------------------------------------------------------- | ------------- | --------------------- | -------------------- | ----------------------------------------- || self | This group | Group | not null | READ | || memberships | Link to collection of all the group's memberships. The list will only include the memberships in projects in which the requesting user has the necessary permissions. | MemberCollection | | READ | **Permission**: view members or manage members in any project || members | The list all all the users that are members of the group | UserCollection | | READ/WRITE | **Permission**: manage members in any project to read & admin to write |Depending on custom fields defined for versions, additional linked properties might exist.## Local Properties| Property | Description | Type | Constraints | Supported operations | Condition || :----------: | --------------------------------------------------------- | -------- | ---------------------------------------------------- | -------------------- | ----------------------------------------------------------- || id | Group's id | Integer | x > 0 | READ | || name | Group's full name, formatting depends on instance settings | String | | READ/WRITE | Admin to write || createdAt | Time of creation | DateTime | | READ | Only visible by admins || updatedAt | Time of the most recent change to the user | DateTime | | READ | Only visible by admins |Depending on custom fields defined for versions, additional properties might exist.
OpenProject Groups API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.2, at version 3.
Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
OpenProject Groups API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Groups are collections of users. They support assigning/unassigning multiple users to/from a project in one operation. This resource does not yet have the form and schema endpoint…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), PrincipalModel (6 properties), ErrorResponse (4 properties), CollectionModel (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenProject 12
Other APIs OpenProject publishes across the network.
This is an independent, third-party profile of OpenProject Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.