v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
Groups

Get users from group

Returns a paginated list of all users in a group.

Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.

Permissions required: either of:

get/rest/api/2/group/member

Query parameters

groupnamestring

As a group's name can change, use of groupId is recommended to identify a group.
The name of the group. This parameter cannot be used with the groupId parameter.

groupIdstring

The ID of the group. This parameter cannot be used with the groupName parameter.

includeInactiveUsersboolean

Include inactive users.

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page (number should be between 1 and 50).

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.