v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB

Group

Get groups

Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

get/wiki/rest/api/group

startinteger

The starting index of the returned groups.

limitinteger

The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

accessType'user' | 'admin' | 'site-admin'

The group permission level for which to filter results.

Returned if the requested groups are returned.

startinteger required

limitinteger required

sizeinteger required

totalSizeinteger

This property will return total count of the objects before pagination is applied. This value is returned if shouldReturnTotalSize is set to true.

_linksGenericLinks required