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

Atlassian Groups API

Manage groups within an organization.

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

This API exposes 17 JSON Schema definitions.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 9 operations across 6 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.atlassian.com, https://your-domain.atlassian.net.

9 operations 6 paths 16 schemas 2 DELETE5 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.atlassian.com
https://your-domain.atlassian.net
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 4

Atlassian Groups API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 7 scopes. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • bearerAuth — Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com.
  • oauth2 — OAuth 2.0 authorization for Atlassian Cloud APIs.
  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 9

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

Groups 9

Manage groups within an organization.

GET
/v1/orgs/{orgId}/groups
Atlassian Get Organization Groups
getOrganizationGroups 2 params → 200401404429
DELETE
/rest/api/3/group
Atlassian Remove Group
atlassianRemovegroup 4 params → 200400401403404
GET
/rest/api/3/groupdeprecated
Atlassian Get Group
atlassianGetgroup 3 params → 200400401403404
POST
/rest/api/3/group
Atlassian Create Group
atlassianCreategroup body → 201400401403
GET
/rest/api/3/group/bulk
Atlassian Bulk Get Groups
atlassianBulkgetgroups 6 params → 200400401403500
GET
/rest/api/3/group/member
Atlassian Get Users From Group
atlassianGetusersfromgroup 5 params → 200400401403404
DELETE
/rest/api/3/group/user
Atlassian Remove User From Group
atlassianRemoveuserfromgroup 4 params → 200400401403404
POST
/rest/api/3/group/user
Atlassian Add User To Group
atlassianAddusertogroup 2 params body → 201400401403404
GET
/rest/api/3/groups/picker
Atlassian Find Groups
atlassianFindgroups 7 params → 200

Schemas 16

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

PaginationLinks
object
Links for cursor-based pagination.
3 properties
GroupPage
object
A paginated list of groups.
2 properties
ErrorResponse
object
Standard error response.
3 properties
Group
object
Represents a group within an organization.
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
PageBeanUserDetails
object
A page of items.
7 properties
GroupDetails
object
Details about a group.
2 properties
GroupLabel
object
A group label.
3 properties
PageBeanGroupDetails
object
A page of items.
7 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
FoundGroup
object
A group found in a search.
4 properties
AddGroupBean
object
1 property 1 required
UpdateUserToGroupBean
object
2 properties
Group_2
object
5 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-groups-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian 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.