v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Group

Get group members

Returns the users that are members of a group.

Use updated Get group API

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

get/wiki/rest/api/group/{groupId}/membersByGroupId

Path parameters

groupIdstring required

The id of the group to be queried for its members.

Query parameters

startinteger

The starting index of the returned users.

limitinteger

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

shouldReturnTotalSizeboolean

Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.

expandstring[]

A multi-value parameter indicating which properties of the user to expand.

  • operations returns the operations that the user is allowed to do.
  • personalSpace returns the user's personal space, if it exists.
  • isExternalCollaborator(@deprecated) see isGuest in response to find out whether the user is a guest.

Response

Returned if the requested users are returned.

startinteger
limitinteger
sizeinteger
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