• Access Mode
  • Admin Group
  • Admin Space
  • Admin User
  • Admin Users
  • Attachments
  • Backup and Restore
  • Category
  • Child Content
  • Cluster information
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • Global Permissions
  • GlobalColorScheme
  • Group
  • Instance Metrics
  • Label
  • Long Task
  • Server Information
  • Space
  • Space Label
  • Space Permissions
  • Space Property
  • Space Watchers
  • SpaceColorScheme
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

Group

Postman Collection
OpenAPI
GET

Get group ancestor of a group

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.

Request

Path parameters

groupName

Group

Required

Query parameters

limit

integer

start

integer

Responses

a collection of parent groups of the given group

application/json

object
GET/rest/api/group/{groupName}/groupancestor
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/group/{groupName}/groupancestor' \ --header 'Accept: application/json'
200Response
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

Get group by name

Get the user group with the group name

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

groupName

string

Required

Query parameters

expand

string

Responses

The user group with the group name

application/json

Group

GET/rest/api/group/{groupName}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/group/{groupName}' \ --header 'Accept: application/json'
GET

Get groups

Get a paginated collection of user groups

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

expand

string

limit

integer

start

integer

Responses

The number of user groups in the system

application/json

object
GET/rest/api/group
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/group' \ --header 'Accept: application/json'
200Response
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

Get members of group

Get a paginated collection of users in the given group

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

groupName

Group

Required

Query parameters

expand

string

limit

integer

start

integer

Responses

a collection of users in the given group

application/json

object
GET/rest/api/group/{groupName}/member
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/group/{groupName}/member' \ --header 'Accept: application/json'
200Response
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

Get group members of group

Get a collection of child groups of the given group

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

groupName

Group

Required

Query parameters

expand

string

limit

integer

start

integer

Responses

a collection of groups in the given group

application/json

object
GET/rest/api/group/{groupName}/groupmember
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/group/{groupName}/groupmember' \ --header 'Accept: application/json'
200Response
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

Get group parents of a group

Get a collection of the given group's immediate parent groups

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

groupName

Group

Required

Query parameters

expand

string

limit

integer

start

integer

Responses

a collection of parent groups of the given group

application/json

object
GET/rest/api/group/{groupName}/groupparent
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/group/{groupName}/groupparent' \ --header 'Accept: application/json'
200Response
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: