Groups

Bulk get groups

Returns a paginated list of groups.

Permissions required: Browse users and groups global permission.

get/rest/api/2/group/bulk

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/group/bulk
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-user)

Query parameters

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.

groupIdstring[]

The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5.

[
  "3571b9a7-348f-414a-9087-8e1ea03a7df8"
]
groupNamestring[]

The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&groupName=jira-software-users.

accessTypestring

The access level of a group. Valid values: 'site-admin', 'admin', 'user'.

applicationKeystring

The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.

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.

Changes

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