/group/{group-id}
Represents an individual group.
GET /group/{group-id} HTTP/1.1
Host: localhost:3000
workspace_groups
permission is required.privacy
field of the group is set to PUBLIC
or PRIVATE
and the current person is attached to the workspace at witch is attached the group.privacy
field of the group is set to HIDDEN
, at least one of the following criteria is met :
Name | Description | Type |
---|---|---|
|
The group ID. |
|
|
The name of the group. |
|
|
The ID of the |
|
|
Notes about the group. |
|
|
Custom fields attached to the group. |
|
|
An array of |
|
|
The ID of the |
|
|
The ID of the |
|
|
The privacy of the group. |
|
|
The user members of the group. |
|
|
The member |
|
|
Set to |
|
|
The user requests of the group. |
|
|
The request |
|
|
The state of the request. |
|
|
The date that indicates when the group was created. |
|
|
The date that indicates when the group was updated for the last time. |
|
You can publish group by using the /user/groups
or /environment/groups
edges.
PUT /group/{group-id} HTTP/1.1
Host: localhost:3000
manage_groups
permission is required.MANAGE
permission) of the workspace at witch is attached the group.Name | Description | Type |
---|---|---|
|
The name of the group. |
|
|
The ID of the |
|
|
Notes about the group. |
|
|
Custom fields attached to the group. |
|
|
An array of |
|
|
The privacy of the group. |
|
If successful :
{
"success": true
}
Otherwise a relevant error message will be returned.
DELETE /group/{post-id} HTTP/1.1
Host: localhost:3000
No fields are required.
If successful :
{
"success": true
}
Otherwise a relevant error message will be returned.