GET /rest/api/2/group/bulk

Returns a paginated list of groups.

Permissions required: Browse users and groups global permission.

Servers

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

groupId[] Array No

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

maxResults Integer No

The maximum number of items to return per page.

Default value: 50

applicationKey String No

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

groupName[] Array No

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

accessType String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.