Atlassian

Atlassian Group API

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

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /wiki/rest/api/group List Confluence user groups · Atlassian Get Groups #

Ask an LLM

“How do I list all the user groups on my Confluence site?”

“Can I page through Confluence groups alphabetically?”

Tell an agent

List all Confluence user groups.

List up to {limit} Confluence groups with access type {accessType}.

POST /wiki/rest/api/group Create a Confluence user group · Atlassian Create New User Group #

Ask an LLM

“How do I create a new user group in Confluence?”

“Do I need to be a site admin to add a Confluence group?”

Tell an agent

Create a Confluence group called {name}.

Add a new user group named {name}.

DELETE /wiki/rest/api/group Delete a group by name · Atlassian Delete User Group #

Ask an LLM

“How do I delete a Confluence group when I only know its name?”

“Can I remove a user group by name rather than id?”

Tell an agent destructive · confirm first

Delete the Confluence group named {name}.

Remove group {name} by its name.

GET /wiki/rest/api/group/by-name Look up a group by name · Atlassian Get Group #

Ask an LLM

“How do I get a Confluence group's details from its name?”

“Can I look up a group by name passed as a query parameter?”

Tell an agent

Get the Confluence group whose name is {name}.

Look up group {name} using the by-name lookup.

GET /wiki/rest/api/group/by-id Look up a group by id · Atlassian Get Group #

Ask an LLM

“How do I fetch a Confluence group using its group id?”

“Can I resolve a group id to the group's name?”

Tell an agent

Get the Confluence group with id {id}.

Resolve group id {id} to its group details.

DELETE /wiki/rest/api/group/by-id Delete a group by id · Atlassian Delete User Group #

Ask an LLM

“How do I delete a Confluence group using its id?”

“Can a site admin remove a group by group id?”

Tell an agent destructive · confirm first

Delete the Confluence group with id {id}.

Remove group id {id} from the site.

GET /wiki/rest/api/group/{groupName} Get a group by name (older path form) · Atlassian Get Group #

Ask an LLM

“Is there a deprecated lookup that returns group details from a name placed in the URL?”

“How do I fetch a group with the legacy group-name path?”

Tell an agent

Get group {groupName} using the legacy path endpoint.

Fetch the older by-path record for group {groupName}.

GET /wiki/rest/api/group/member List group members by group name · Atlassian Get Group Members #

Ask an LLM

“Who are the members of a Confluence group I know by name?”

“Can I get the total count of members in a named group?”

Tell an agent

List the members of group {name}.

Show up to {limit} members of group {name} with the total size.

GET /wiki/rest/api/group/{groupName}/member List group members (older path form) · Atlassian Get Group Members #

Ask an LLM

“How do I list a group's members with the legacy path-based endpoint?”

“Which members does a group have when I pass its name in the URL of the legacy members call?”

Tell an agent

List members of {groupName} via the legacy path endpoint.

Page through members of group {groupName} starting at {start} using the older path.

GET /wiki/rest/api/group/picker Search groups by partial name · Atlassian Search Groups By Partial Query #

Ask an LLM

“How do I find Confluence groups when I only know part of the name?”

“Can I autocomplete group names from a few letters?”

Tell an agent

Search groups matching {query}.

Find up to {limit} groups whose names contain {query}.

POST /wiki/rest/api/group/userByGroupId Add a user to a group by group id · Atlassian Add Member To Group By Groupid #

Ask an LLM

“How do I add someone to a Confluence group using the group id?”

“Can I add a member by account id to a group I know only by id?”

Tell an agent

Add user {accountId} to group id {groupId}.

Put account {accountId} into the group with id {groupId}.

DELETE /wiki/rest/api/group/userByGroupId Remove a user from a group by group id · Atlassian Remove Member From Group Using Group Id #

Ask an LLM

“How do I take a user out of a Confluence group using the group id?”

“Can I remove a member by account id from a group identified by id?”

Tell an agent destructive · confirm first

Remove user {accountId} from group id {groupId}.

Drop a member from the group with id {groupId}.

GET /wiki/rest/api/group/{groupId}/membersByGroupId List group members by group id · Atlassian Get Group Members #

Ask an LLM

“How do I list who belongs to a group when I have its group id?”

“Can I count members of a group identified by id?”

Tell an agent

List members of group id {groupId}.

Show {limit} members of group id {groupId} including the total.

POST /wiki/rest/api/group/user Add a user to a group by group name · Atlassian Add Member To Group #

Ask an LLM

“How do I add a user to a Confluence group by its name?”

“Who is allowed to add members to a named group?”

Tell an agent

Add user {accountId} to the group named {name}.

Make account {accountId} a member of group {name}.

DELETE /wiki/rest/api/group/user Remove a user from a group by group name · Atlassian Remove Member From Group #

Ask an LLM

“How do I remove someone from a Confluence group by the group's name?”

“Can I take a member out of a named group using their account id?”

Tell an agent destructive · confirm first

Remove user {accountId} from the group named {name}.

Take a member out of group {name}.

Documentation

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-webhooks/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-snippets/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-users/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit/

https://developer.atlassian.com/cloud/confluence/connect-modules/

https://developer.atlassian.com/cloud/confluence/rest/v2/intro/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template/

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-openapi

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/

https://developer.atlassian.com/server/framework/atlassian-sdk/audit/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/

https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/

https://developer.atlassian.com/cloud/jira/platform/connect-api-migration/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/

https://developer.atlassian.com/cloud/jira/platform/data-security-policy-developer-guide/

https://developer.atlassian.com/platform/forge/events-reference/jira/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters/

https://developer.atlassian.com/cloud/jira/platform/forge/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-types/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/

https://developer.atlassian.com/platform/marketplace/license-api-for-cloud-apps/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-priorities/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions/

https://developer.atlassian.com/server/jira/platform/webhooks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/

https://developer.atlassian.com/cloud/admin/organization/rest/

https://developer.atlassian.com/cloud/admin/user-management/rest/

https://developer.atlassian.com/cloud/admin/user-provisioning/rest/

Specifications

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-group-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-hook-events-paginated_hook_events-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-pull-requests-a_pullrequest_comment_task-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-repositories-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-snippets-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-teams-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-user-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-workspaces-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-body-async-content-body-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-states-async-id-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-group-group-array-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-inline-tasks-task-page-response-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-longtask-long-task-status-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-search-search-page-response-search-result-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-space-content-state-settings-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-template-blueprint-template-array-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-user-account-id-email-record-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-admin-domain-page-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-hook-events-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-pull-requests-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-repositories-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-snippets-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-teams-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-workspaces-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-audit-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-body-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-states-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-group-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-inline-tasks-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-longtask-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-relation-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-search-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-settings-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-space-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-template-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-user-context.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: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.

GitHub Google LinkedIn

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

OpenAPI Specification

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.
  termsOfService: https://atlassian.com/terms/
  version: 1.0.0
servers:
- url: //your-domain.atlassian.net
tags:


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