Atlassian Group API

The Group API from Atlassian — 10 operation(s) for group.

Operations 15

GET /wiki/rest/api/group Atlassian Get Groups #
POST /wiki/rest/api/group Atlassian Create New User Group #
DELETE /wiki/rest/api/group Atlassian Delete User Group #
GET /wiki/rest/api/group/by-name Atlassian Get Group #
GET /wiki/rest/api/group/by-id Atlassian Get Group #
DELETE /wiki/rest/api/group/by-id Atlassian Delete User Group #
GET /wiki/rest/api/group/{groupName} Atlassian Get Group #
GET /wiki/rest/api/group/member Atlassian Get Group Members #
GET /wiki/rest/api/group/{groupName}/member Atlassian Get Group Members #
GET /wiki/rest/api/group/picker Atlassian Search Groups By Partial Query #
POST /wiki/rest/api/group/userByGroupId Atlassian Add Member To Group By Groupid #
DELETE /wiki/rest/api/group/userByGroupId Atlassian Remove Member From Group Using Group Id #
GET /wiki/rest/api/group/{groupId}/membersByGroupId Atlassian Get Group Members #
POST /wiki/rest/api/group/user Atlassian Add Member To Group #
DELETE /wiki/rest/api/group/user Atlassian Remove Member From Group #

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/
📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-webhooks/
📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/
📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/
📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-snippets/
📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/
📖
Documentation
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-users/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/connect-modules/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values--apps-/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-openapi
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/
📖
Documentation
https://developer.atlassian.com/server/framework/atlassian-sdk/audit/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/connect-api-migration/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/data-security-policy-developer-guide/
📖
Documentation
https://developer.atlassian.com/platform/forge/events-reference/jira/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/forge/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-types/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/
📖
Documentation
https://developer.atlassian.com/platform/marketplace/license-api-for-cloud-apps/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-priorities/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-roles/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications--apps-/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions/
📖
Documentation
https://developer.atlassian.com/server/jira/platform/webhooks/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-schemes/
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/
📖
Documentation
https://developer.atlassian.com/cloud/admin/organization/rest/
📖
Documentation
https://developer.atlassian.com/cloud/admin/user-management/rest/
📖
Documentation
https://developer.atlassian.com/cloud/admin/user-provisioning/rest/

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-hook-events-paginated_hook_events-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-pull-requests-a_pullrequest_comment_task-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-repositories-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-snippets-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-teams-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-user-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-workspaces-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-body-async-content-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-states-async-id-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-group-group-array-with-links-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-inline-tasks-task-page-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-longtask-long-task-status-with-links-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-search-search-page-response-search-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-space-content-state-settings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-template-blueprint-template-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-user-account-id-email-record-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-admin-domain-page-schema.json

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/graphql/atlassian-graphql.md
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-hook-events-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-pull-requests-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-repositories-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-snippets-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-teams-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-user-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-workspaces-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-audit-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-body-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-states-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-group-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-inline-tasks-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-longtask-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-relation-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-search-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-settings-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-space-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-template-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-user-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-admin-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/atlassian-group-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

atlassian-group-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Atlassian The Confluence Cloud REST Group API
  description: This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.
  termsOfService: https://atlassian.com/terms/
  version: 1.0.0
servers:
- url: //your-domain.atlassian.net
tags:
- name: Group
paths:
  /wiki/rest/api/group:
    get:
      tags:
      - Group
      summary: Atlassian Get Groups
      description: Returns all user groups. The returned groups are ordered alphabetically in<br>ascending order by group name.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetgroups
      parameters:
      - name: start
        in: query
        description: The starting index of the returned groups.
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: 'The maximum number of groups to return per page.

          Note, this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 200
      - name: accessType
        in: query
        description: The group permission level for which to filter results.
        required: false
        schema:
          type: string
          default: null
          enum:
          - user
          - admin
          - site-admin
      responses:
        '200':
          description: Returned if the requested groups are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupArrayWithLinks'
        '403':
          description: 'Returned if the calling user does not have permission to view

            groups.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
    post:
      tags:
      - Group
      summary: Atlassian Create New User Group
      description: Creates a new user group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianCreategroup
      requestBody:
        description: Name of the group that is to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupName'
        required: true
      responses:
        '201':
          description: Returned if the group was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '400':
          description: Returned if the name is missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: Returned if the user is not a site admin.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-codegen-request-body-name: body
      x-atlassian-connect-scope: INACCESSIBLE
    delete:
      tags:
      - Group
      summary: Atlassian Delete User Group
      description: Delete user group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianRemovegroup
      parameters:
      - name: name
        in: query
        description: Name of the group to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Returned if the group was removed successfully.
          content: {}
        '400':
          description: Returned if the name is missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: Returned if the user is not a site admin.
          content: {}
        '404':
          description: If no user group by the give name exists.
          content: {}
      deprecated: true
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: INACCESSIBLE
  /wiki/rest/api/group/by-name:
    get:
      tags:
      - Group
      summary: Atlassian Get Group
      description: Returns a user group for a given group name.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetgroupbyqueryparam
      parameters:
      - name: name
        in: query
        description: 'The name of the group. This is the same as the group name shown in

          the Confluence administration console.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returned if the requested group is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '403':
          description: 'Returned if the calling user does not have permission to view

            groups.'
          content: {}
        '404':
          description: Returned if the group does not exist.
          content: {}
      deprecated: true
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
  /wiki/rest/api/group/by-id:
    get:
      tags:
      - Group
      summary: Atlassian Get Group
      description: Returns a user group for a given group id.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetgroupbygroupid
      parameters:
      - name: id
        in: query
        description: The id of the group.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returned if the requested group is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '403':
          description: 'Returned if the calling user does not have permission to view

            groups.'
          content: {}
        '404':
          description: Returned if the group does not exist.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
    delete:
      tags:
      - Group
      summary: Atlassian Delete User Group
      description: Delete user group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianRemovegroupbyid
      parameters:
      - name: id
        in: query
        description: Id of the group to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Returned if the group was removed successfully.
          content: {}
        '400':
          description: Returned if the id is missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: Returned if the user is not a site admin.
          content: {}
        '404':
          description: If no user group by the given id exists.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: INACCESSIBLE
  /wiki/rest/api/group/{groupName}:
    get:
      tags:
      - Group
      summary: Atlassian Get Group
      description: Returns a user group for a given group name.<br><br>Use updated Get group API<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetgroupbyname
      parameters:
      - name: groupName
        in: path
        description: 'The name of the group. This is the same as the group name shown in

          the Confluence administration console.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returned if the requested group is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '403':
          description: 'Returned if the calling user does not have permission to view

            groups.'
          content: {}
        '404':
          description: Returned if the group does not exist.
          content: {}
      deprecated: true
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
  /wiki/rest/api/group/member:
    get:
      tags:
      - Group
      summary: Atlassian Get Group Members
      description: Returns the users that are members of a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetmembersbyqueryparam
      parameters:
      - name: name
        in: query
        description: The name of the group to be queried for its members.
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: The starting index of the returned users.
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: 'The maximum number of users to return per page.

          Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter

          exceeds 200, this API will return a maximum of 200 users per page.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 200
      - name: shouldReturnTotalSize
        in: query
        description: 'Whether to include total size parameter in the results.

          Note, fetching total size property is an expensive operation; use it if your use case needs this value.'
        schema:
          type: boolean
          default: false
      - name: expand
        in: query
        description: "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns the operations that the user is allowed to do.\n  - `personalSpace` returns the user's personal space, if it exists.\n  - `isExternalCollaborator` returns whether the user is an external collaborator user."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - operations
            - personalSpace
            - isExternalCollaborator
      responses:
        '200':
          description: Returned if the requested users are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserArray'
        '403':
          description: Returned if the calling user does not have permission to view users.
          content: {}
      deprecated: true
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
        - read:user:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
  /wiki/rest/api/group/{groupName}/member:
    get:
      tags:
      - Group
      summary: Atlassian Get Group Members
      description: Returns the users that are members of a group.<br><br>Use updated Get group API<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetgroupmembers
      parameters:
      - name: groupName
        in: path
        description: The name of the group to be queried for its members.
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: The starting index of the returned users.
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: 'The maximum number of users to return per page.

          Note, this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 200
      responses:
        '200':
          description: Returned if the requested users are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserArray'
        '400':
          description: Returned if given limit is greater than 200
          content: {}
        '403':
          description: Returned if the calling user does not have permission to view users.
          content: {}
      deprecated: true
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
  /wiki/rest/api/group/picker:
    get:
      tags:
      - Group
      summary: Atlassian Search Groups By Partial Query
      description: Get search results of groups by partial query provided.
      operationId: atlassianSearchgroups
      parameters:
      - name: query
        in: query
        description: the search term used to query results.
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: The starting index of the returned groups.
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: 'The maximum number of groups to return per page.

          Note, this is restricted to a maximum limit of 200 groups.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 200
      - name: shouldReturnTotalSize
        in: query
        description: 'Whether to include total size parameter in the results.

          Note, fetching total size property is an expensive operation; use it if your use case needs this value.'
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Returns a full JSON representation of group collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupArrayWithLinks'
        '403':
          description: 'Returned if the calling user does not have permission to view

            groups.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
  /wiki/rest/api/group/userByGroupId:
    post:
      tags:
      - Group
      summary: Atlassian Add Member To Group By Groupid
      description: Adds a user as a member in a group represented by its groupId<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianAddusertogroupbygroupid
      parameters:
      - name: groupId
        in: query
        description: GroupId of the group whose membership is updated
        required: true
        schema:
          type: string
      requestBody:
        description: AccountId of the user who needs to be added as member.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountId'
        required: true
      responses:
        '201':
          description: Returned if the group was created successfully.
          content: {}
        '400':
          description: Returned if the groupId or accountId are missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: Returned if the user is not a site admin.
          content: {}
        '404':
          description: If no user group by the give name exists.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-codegen-request-body-name: body
      x-atlassian-connect-scope: INACCESSIBLE
    delete:
      tags:
      - Group
      summary: Atlassian Remove Member From Group Using Group Id
      description: Remove user as a member from a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianRemovememberfromgroupbygroupid
      parameters:
      - name: groupId
        in: query
        description: Id of the group whose membership is updated.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/userLookupKey'
      - $ref: '#/components/parameters/userLookupUsername'
      - $ref: '#/components/parameters/userLookupAccountId'
      responses:
        '204':
          description: Returned if the group was removed successfully.
          content: {}
        '400':
          description: Returned if the name is missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: 'Returned if the user is not a site admin.

            Note: A 204 is returned if the user is not part of the

            group.'
          content: {}
        '404':
          description: 'If no user group by the give name exists or if no user exists

            for the given accountId.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: INACCESSIBLE
  /wiki/rest/api/group/{groupId}/membersByGroupId:
    get:
      tags:
      - Group
      summary: Atlassian Get Group Members
      description: Returns the users that are members of a group.<br><br>Use updated Get group API<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission).
      operationId: atlassianGetgroupmembersbygroupid
      parameters:
      - name: groupId
        in: path
        description: The id of the group to be queried for its members.
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: The starting index of the returned users.
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: 'The maximum number of users to return per page.

          Note, this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 200
      - name: shouldReturnTotalSize
        in: query
        description: 'Whether to include total size parameter in the results.

          Note, fetching total size property is an expensive operation; use it if your use case needs this value.'
        schema:
          type: boolean
          default: false
      - name: expand
        in: query
        description: "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns the operations that the user is allowed to do.\n  - `personalSpace` returns the user's personal space, if it exists.\n  - `isExternalCollaborator` returns whether the user is an external collaborator user."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - operations
            - personalSpace
            - isExternalCollaborator
      responses:
        '200':
          description: Returned if the requested users are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserArray'
        '400':
          description: Returned if given limit is greater than 200
          content: {}
        '403':
          description: Returned if the calling user does not have permission to view users.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:group:confluence
        - read:user:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
  /wiki/rest/api/group/user:
    post:
      tags:
      - Group
      summary: Atlassian Add Member To Group
      description: Adds a user as a member in a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianAddusertogroup
      parameters:
      - name: name
        in: query
        description: Name of the group whose membership is updated
        required: true
        schema:
          type: string
      requestBody:
        description: AccountId of the user who needs to be added as member.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountId'
        required: true
      responses:
        '201':
          description: Returned if the group was created successfully.
          content: {}
        '400':
          description: Returned if the name or accountId are missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: Returned if the user is not a site admin.
          content: {}
        '404':
          description: If no user group by the give name exists.
          content: {}
      deprecated: true
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-codegen-request-body-name: body
      x-atlassian-connect-scope: INACCESSIBLE
    delete:
      tags:
      - Group
      summary: Atlassian Remove Member From Group
      description: Remove user as a member from a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin.
      operationId: atlassianRemovememberfromgroup
      parameters:
      - name: name
        in: query
        description: Name of the group whose membership is updated.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/userLookupKey'
      - $ref: '#/components/parameters/userLookupUsername'
      - $ref: '#/components/parameters/userLookupAccountId'
      responses:
        '204':
          description: Returned if the group was removed successfully.
          content: {}
        '400':
          description: Returned if the name is missing or invalid.
          content: {}
        '401':
          description: Returned if the calling user is not logged in to Confluence.
          content: {}
        '403':
          description: 'Returned if the user is not a site admin.

            Note: A 204 is returned if the user is not part of the

            group.'
          content: {}
        '404':
          description: 'If no user group by the give name exists or if no user exists

            for the given accountId.'
          content: {}
      deprecated: true
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-groups
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-groups
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - write:group:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: INACCESSIBLE
components:
  schemas:
    ContentLookAndFeel:
      type: object
      properties:
        screen:
          $ref: '#/components/schemas/ScreenLookAndFeel'
        container:
          $ref: '#/components/schemas/ContainerLookAndFeel'
        header:
          $ref: '#/components/schemas/ContainerLookAndFeel'
        body:
          $ref: '#/components/schemas/ContainerLookAndFeel'
    GenericAccountId:
      type:
      - string
      - 'null'
      description: 'The account ID of the user, which uniquely identifies the user across all Atlassian products.

        For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.'
    ContentBody:
      required:
      - representation
      - value
      type: object
      properties:
        value:
          type: string
        representation:
          type: string
          enum:
          - view
          - export_view
          - styled_view
          - storage
          - editor
          - editor2
          - anonymous_export_view
          - wiki
          - atlas_doc_format
          - raw
        embeddedContent:
          type: array
          items:
            $ref: '#/components/schemas/EmbeddedContent'
        webresource:
          $ref: '#/components/schemas/WebResourceDependencies'
        mediaToken:
          type: object
          properties:
            collectionIds:
              type: array
              items:
                type: string
            contentId:
              type: string
            expiryDateTime:
              type: string
            fileIds:
              type: array
              items:
                type: string
            token:
              type: string
        _expandable:
          type: object
          properties:
            content:
              type: string
            embeddedContent:
              type: string
            webresource:
              type: string
            mediaToken:
              type: string
        _links:
          $ref: '#/components/schemas/GenericLinks'
    HeaderLookAndFeel:
      required:
      - backgroundColor
      - button
      - primaryNavigation
      - search
      - secondaryNavigation
      type: object
      properties:
        backgroundColor:
          type: string
        button:
          $ref: '#/components/schemas/ButtonLookAndFeel'
        primaryNavigation:
          $ref: '#/components/schemas/NavigationLookAndFeel'
        secondaryNavigation:
          $ref: '#/components/schemas/NavigationLookAndFeel'
        search:
          $ref: '#/components/schemas/SearchFieldLookAndFeel'
    ContentArray:
      required:
      - _links
      - results
      - size
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/Content'
        start:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        _links:
          $ref: '#/components/schemas/GenericLinks'
    SearchFieldLookAndFeel:
      required:
      - backgroundColor
      - color
      type:
      - object
      - 'null'
      properties:
        backgroundColor:
          type: string
        color:
          type: string
    ButtonLookAndFeel:
      required:
      - backgroundColor
      - color
      type:
      - object
      - 'null'
      properties:
        backgroundColor:
          type: string
        color:
          type: string
    GenericUserKey:
      type:
      - string
      - 'null'
      description: 'This property is no longer available and will be removed from the documentation soon.

        Use `accountId` instead.

        See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.'
    ScreenLookAndFeel:
      required:
      - background
      type: object
      properties:
        background:
          type: string
        backgroundAttachment:
          ty

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-group-api-openapi.yml