Collaboration Basic Auth

Confluence REST API

Team collaboration and documentation workspace API

Confluence is Atlassian's team workspace platform that enables teams to create, share, and collaborate on documentation, meeting notes, and knowledge bases. The Confluence REST API allows developers to programmatically manage spaces, pages, content, comments, and user permissions, making it ideal for automating documentation workflows, integrating with CI/CD pipelines, and building custom knowledge management solutions.

Base URL https://your-domain.atlassian.net/wiki/rest/api

API Endpoints

Method	Endpoint	Description
GET	`/space`	Retrieve a list of all spaces with their metadata and permissions
GET	`/space/{spaceKey}`	Get detailed information about a specific space by its key
POST	`/space`	Create a new space with specified name, key, and description
GET	`/content`	Search and retrieve content (pages, blog posts) with filtering options
GET	`/content/{id}`	Get a specific piece of content by its ID with version history
POST	`/content`	Create new content such as pages or blog posts with rich text body
PUT	`/content/{id}`	Update existing content including title, body, and metadata
DELETE	`/content/{id}`	Delete a page or blog post by its content ID
GET	`/content/{id}/child`	Retrieve all child pages under a parent page in the hierarchy
GET	`/content/{id}/history`	Get version history and change details for a specific page
POST	`/content/{id}/label`	Add labels/tags to content for better organization and searching
GET	`/content/search`	Perform advanced search using CQL (Confluence Query Language)
GET	`/user`	Retrieve user information by username or account ID
POST	`/content/{id}/notification/created`	Send notifications to watchers when content is created
GET	`/audit`	Access audit logs for space and content changes

Code Examples

curl -X GET 'https://your-domain.atlassian.net/wiki/rest/api/content?spaceKey=TEAM&type=page&limit=10' \
  -H 'Authorization: Basic base64(email:api_token)' \
  -H 'Content-Type: application/json'

const response = await fetch('https://your-domain.atlassian.net/wiki/rest/api/content?spaceKey=TEAM&type=page&limit=10', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic ' + btoa('email@example.com:your_api_token'),
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data.results);

import requests
from requests.auth import HTTPBasicAuth

url = 'https://your-domain.atlassian.net/wiki/rest/api/content'
params = {'spaceKey': 'TEAM', 'type': 'page', 'limit': 10}

response = requests.get(
    url,
    params=params,
    auth=HTTPBasicAuth('email@example.com', 'your_api_token'),
    headers={'Content-Type': 'application/json'}
)

pages = response.json()['results']
for page in pages:
    print(f"{page['title']}: {page['_links']['webui']}")

Connect Confluence to AI

Deploy a Confluence MCP server on IOX Cloud and connect it to Claude, ChatGPT, Cursor, or any AI client. Your AI assistant gets direct access to Confluence through these tools:

search_confluence_pages Search Confluence pages using CQL queries and return relevant documentation with metadata and links

create_confluence_page Create new Confluence pages with AI-generated content in specified spaces with proper formatting

get_page_content Retrieve the full content and metadata of a specific Confluence page for context or summarization

update_page_content Update existing Confluence pages with new information while preserving version history

get_space_overview Get comprehensive information about spaces including pages, permissions, and recent activity for knowledge navigation

Deploy in 60 seconds

Describe what you need, AI generates the code, and IOX deploys it globally.

Deploy Confluence MCP Server →

Confluence REST API

API Endpoints

Code Examples

Connect Confluence to AI

Deploy in 60 seconds

Related APIs