ATatlassian
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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/group
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-groups

Query parameters

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.

Response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.