provider Groups GET /rest/api/3/group
@utdk/jira /rest/api/3/group
Get group
This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users in a group. **[Permissions](#permissions) required:** either of: * *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
groupname query
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.
string
groupId query
The ID of the group. This parameter cannot be used with the `groupName` parameter.
string
expand query
List of fields to expand.
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.

getgroup
GET/rest/api/3/group
This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users in a group. **[Permissions](#permissions) required:** either of: * *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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.

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

List of fields to expand.

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.getgroup()