OpenProject Memberships API
Users and groups can become members of a project. Such a membership will also have one or more roles assigned to it. By that, memberships control the permissions a user has within a project.There are also memberships that do not govern the permissions within a certain project but rather govern global permissions. Among the permissions that can be granted like this are the permissions to "Create project" and "Manage users". Those memberships do not have a project associated.When creating and updating memberships, a custom message can be sent to users of new and updated memberships. This message can be provided within the `_meta` group.## Linked Properties| Link | Description | Type | Constraints | Supported operations ||:-------------------:|----------------------------------------- | ------------- | -------------------------------------------------------------- | -------------------- || self | This membership | Membership | not null | READ || project | The project for which the membership is granted | Project | | READ || roles | The list of roles the user or group is granted in the project | RoleCollection | not null | READ || principal | The user or group that was granted membership | User or Group | not null | READ |## Local Properties| Property | Description | Type | Constraints | Supported operations || :---------: | --------------------------------------------- | ----------- | ----------- | -------------------- || id | Membership id | Integer | x > 0 | READ || createdAt | Time of creation | DateTime | not null | READ || updatedAt | Time of latest update | DateTime | not null | READ |## Meta parameters| Meta property | Description | Type | Constraints | Supported operations |Condition || :------------------------: | --------------------------------------------------- | ---- | ----------- | -------------------- |----------|| notificationMessage | The message included in the email(s) send to the users of new or updated memberships | Formattable | | READ/WRITE | |
OpenProject Memberships API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Memberships. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 9 operations across 6 paths, and defines 25 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 Memberships API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 9
Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Users and groups can become members of a project. Such a membership will also have one or more roles assigned to it. By that, memberships control the permissions a user has within…
Schemas 25
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are SchemaPropertyModel (9 properties), Link (7 properties), PrincipalModel (6 properties), MembershipReadModel (6 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 Memberships 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.