How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Groups API

This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)

Jira Groups API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 8 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

8 operations 5 paths 12 schemas 2 DELETE4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Groups API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Groups 8

This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group nam…

DELETE
/rest/api/3/group
Remove group
removeGroup 4 params → 200400401403404
GET
/rest/api/3/groupdeprecated
Get group
getGroup 3 params → 200400401403404
POST
/rest/api/3/group
Create group
createGroup body → 201400401403
GET
/rest/api/3/group/bulk
Bulk get groups
bulkGetGroups 6 params → 200400401403500
GET
/rest/api/3/group/member
Get users from group
getUsersFromGroup 5 params → 200400401403404
DELETE
/rest/api/3/group/user
Remove user from group
removeUserFromGroup 4 params → 200400401403404429
POST
/rest/api/3/group/user
Add user to group
addUserToGroup 2 params body → 201400401403404429
GET
/rest/api/3/groups/picker
Find groups
findGroups 7 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are UserDetails (10 properties), PageBeanUserDetails (7 properties), FoundGroup (7 properties), PageBeanGroupDetails (7 properties). Each schema is shown below with its type and property counts.

GroupLabel
object
A group label.
3 properties
PagedListUserDetailsApplicationUser
object
A paged list. To access additional details append [start-index:end-index] to the expand request. For example, ?expand=sharedUsers[10:40] returns a list startin…
5 properties
AvatarUrlsBean
object
4 properties
AddGroupBean
object
1 property 1 required
GroupDetails
object
Details about a group.
2 properties
UserDetails
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties
PageBeanGroupDetails
object
A page of items.
7 properties
FoundGroup
object
A group found in a search.
7 properties
Group
object
5 properties
PageBeanUserDetails
object
A page of items.
7 properties
FoundGroups
object
The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.
3 properties
UpdateUserToGroupBean
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-groups-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.