provider Groups GET /rest/api/3/group/bulk
@utdk/jira /rest/api/3/group/bulk
Bulk get groups
Returns a [paginated](#pagination) list of groups. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
startAt query
The index of the first item to return in a page of results (page offset).
integer
maxResults query
The maximum number of items to return per page.
integer
groupId query
The ID of a group. To specify multiple IDs, pass multiple `groupId` parameters. For example, `groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5`.
array
groupName query
The name of a group. To specify multiple names, pass multiple `groupName` parameters. For example, `groupName=administrators&groupName=jira-software-users`.
array
accessType query
The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
string
applicationKey query
The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.
string

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

bulkgetgroups
GET/rest/api/3/group/bulk
Returns a [paginated](#pagination) list of groups. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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

The maximum number of items to return per page.

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

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

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.bulkgetgroups({
  "startAt": 0,
  "maxResults": 50
})