Get a collection of the specified group's direct parent groups and all its ancestors (i.e. the parents of its parents, and so on)
Forge and OAuth2 apps cannot access this REST resource.
Group
Requiredinteger
integer
a collection of parent groups of the given group
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/group/{groupName}/groupancestor' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"totalCount": 2154,
"results": [],
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Get the user group with the group name
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
The user group with the group name
Group
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/group/{groupName}' \
--header 'Accept: application/json'Get a paginated collection of user groups
Forge and OAuth2 apps cannot access this REST resource.
string
integer
integer
The number of user groups in the system
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/group' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"totalCount": 2154,
"results": [],
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Get a paginated collection of users in the given group
Forge and OAuth2 apps cannot access this REST resource.
Group
Requiredstring
integer
integer
a collection of users in the given group
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/group/{groupName}/member' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"totalCount": 2154,
"results": [
{
"profilePicture": {
"path": "http://www.example.com/path/to/image.png",
"width": 16,
"height": 16,
"isDefault": true
},
"displayName": "Joe Smith",
"type": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Get a collection of child groups of the given group
Forge and OAuth2 apps cannot access this REST resource.
Group
Requiredstring
integer
integer
a collection of groups in the given group
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/group/{groupName}/groupmember' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"totalCount": 2154,
"results": [],
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Get a collection of the given group's immediate parent groups
Forge and OAuth2 apps cannot access this REST resource.
Group
Requiredstring
integer
integer
a collection of parent groups of the given group
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/group/{groupName}/groupparent' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"totalCount": 2154,
"results": [],
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Rate this page: