Confluence

Confluence Group API

**[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/) 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.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 8

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 user groups · Get groups #
Ask an LLM
“What user groups exist on my Confluence site?”
“Are groups returned in alphabetical order?”
Tell an agent
List all user groups on the site.
List the first {limit} groups alphabetically.
POST /wiki/rest/api/group Create a user group · 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 group?”
Tell an agent
Create a user group called {name}.
Add a new group named {name} to the site.
GET /wiki/rest/api/group/by-id Get a group by its id · Get group #
Ask an LLM
“Can I look up a group's details from its group id?”
“What does a single user group record contain?”
Tell an agent
Show the group with id {id}.
Fetch details of user group {id}.
DELETE /wiki/rest/api/group/by-id Delete a user group · Delete user group #
Ask an LLM
“How do I delete a user group I no longer need?”
“Who is allowed to remove a group from the site?”
Tell an agent destructive · confirm first
Delete the user group with id {id}.
Remove group {id} from the site entirely.
GET /wiki/rest/api/group/picker Search groups by partial name · Search groups by partial query #
Ask an LLM
“Can I find groups by typing just part of their name?”
“Is there a way to get the total count of groups matching a search?”
Tell an agent
Search for groups whose name matches {query}.
Find up to {limit} groups matching {query}.
GET /wiki/rest/api/group/{groupId}/membersByGroupId List the members of a group · Get group members #
Ask an LLM
“Who are the users in a particular Confluence group?”
“Can I get the total member count along with a group's users?”
Tell an agent
List the members of group {groupId}.
Show the first {limit} users in group {groupId}.
POST /wiki/rest/api/group/userByGroupId Add a user to a group · Add member to group by groupId #
Ask an LLM
“How do I add someone to a Confluence group?”
“Can I add a member to a group using their account id?”
Tell an agent
Add user {accountId} to group {groupId}.
Make account {accountId} a member of group {groupId}.
DELETE /wiki/rest/api/group/userByGroupId Remove a user from a group · Remove member from group using group id #
Ask an LLM
“How do I take a user out of a group?”
“Does removing someone from a group require site admin rights?”
Tell an agent destructive · confirm first
Remove user {accountId} from group {groupId}.
Revoke group {groupId} membership for account {accountId}.

Documentation

📖
APIReference
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/security-overview/
📖
GettingStarted
https://developer.atlassian.com/cloud/confluence/getting-started/
📖
APIReference
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/

Specifications

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

Other Resources

🔗
Postman
https://developer.atlassian.com/cloud/confluence/confcloud.2.postman.json
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/collections/confluence-confcloud-v2.postman_collection.json

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/confluence:confluence-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

confluence-group-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: 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 (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-group-api-openapi.yml