Groups
Groups are collections of users. They support assigning/unassigning multiple users to/from a project in one operation.
This resource is currently a stub.
Actions
None
Linked Properties
Link | Description | Type | Constraints | Supported operations | Condition |
---|---|---|---|---|---|
self | This group | Group | not null | READ | |
members | Link ot 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 |
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 | ||
createdAt | Time of creation | DateTime | READ | ||
updatedAt | Time of the most recent change to the user | DateTime | READ |
Group
View group
- Parameters
- id
integer
(required) Example: 1Group id.
- Response
200
Toggle details Headers
Content-Type: application/hal+json
Body
{ "_type": "Group", "id": 9, "name": "The group", "createdAt": "2015-09-23T11:06:36Z", "updatedAt": "2015-09-23T11:06:36Z", "_links": { "self": { "href": "/api/v3/groups/9", "title": "The group" } } }
- Response
404
Toggle details Returned if the group does not exist or if the API user does not have permission to view them.
Required permission If the user has the manage members permission in at least one project the user will be able to query all groups. If not, the user will be able to query all groups which are members in projects, he has the view members permission in.
Headers
Content-Type: application/hal+json
Body
{ "_type": "Error", "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound", "message": "The requested resource could not be found." }
Help and feedback
If you did not find what you were looking for
If you need help from the community or want to support others
If you are eligible for professional support and have more questions
REQUEST SUPPORT
If you find an easily fixable error or need for improvement in the documentation for the stable release
If you would like to suggest bigger updates or improvements to this documentation
If you want to contribute to translate this documentation to another language
If there's something you don't like or understand about this feature
If you want to propose a new feature that OpenProject does not offer yet
To further help OpenProject to shape and test new features
To view OpenProject premium features and pricing
If you want to try all premium features in the OpenProject Cloud Edition 14 days for free
If you want to try all premium features in your on premise Community installation 14 days for free