Atlassian Confluence

Atlassian Confluence is a team collaboration and wiki platform for creating, organizing, and discussing work with your team. It provides REST APIs (v1 and v2) and a GraphQL API for managing content, spaces, pages, users, labels, and search across Confluence Cloud deployments, enabling automation, app development, and integration with enterprise workflows.

3 APIs 6 Features

AtlassianCollaborationContent ManagementDocumentationKnowledge ManagementWiki

APIs

Confluence Cloud REST API

The primary REST API for Confluence Cloud, providing access to content, spaces, users, and more.

Confluence Cloud REST API V2

The next generation REST API for Confluence Cloud with improved performance and new capabilities.

Confluence Cloud GraphQL API

The Confluence Cloud GraphQL API provides flexible querying and mutation capabilities for Confluence content, spaces, pages, and user data using OAuth 2.0 authentication.

Collections

Atlassian Confluence Cloud REST API (v1 and v2)

OPEN

GraphQL

Atlassian Confluence GraphQL API

The Confluence Cloud GraphQL API provides flexible querying and mutation capabilities for Confluence content, spaces, pages, and user data using OAuth 2.0 authentication.

GRAPHQL

Pricing Plans

Atlassian Confluence Plans Pricing

3 plans

PLANS

Rate Limits

Atlassian Confluence Rate Limits

5 limits

RATE LIMITS

FinOps

Atlassian Confluence Finops

FINOPS

Features

Content Management API

Create, read, update, and delete Confluence pages, blog posts, and spaces programmatically via REST or GraphQL.

CQL Search

Execute powerful content searches using Confluence Query Language (CQL) to find pages, users, and spaces.

User and Group Management

Manage Confluence users, groups, and permissions programmatically using the REST API.

Forge App Development

Build Confluence apps with the Atlassian Forge platform using serverless functions and UI extensions.

Webhook Support

Subscribe to Confluence events via webhooks to trigger workflows on content creation, update, and deletion.

OAuth 2.0 Authentication

Secure API access via OAuth 2.0 three-legged authorization for user-facing integrations.

Use Cases

Documentation Automation

Automatically create and update Confluence pages from CI/CD pipelines, JIRA data, or external documentation sources.

Content Migration

Migrate content from other wikis and knowledge bases into Confluence using the REST API bulk import capabilities.

Enterprise Search Integration

Index and search Confluence content from enterprise search platforms using the CQL search API.

Custom App Development

Build custom Confluence apps and macros using Forge to extend the platform with team-specific workflows.

Reporting and Analytics

Extract page views, space statistics, and content metadata for custom analytics and reporting dashboards.

Integrations

Jira

Deep native integration linking Confluence pages to Jira issues, projects, and sprints for unified project documentation.

Slack

Confluence Slack integration for notifications, page previews, and content sharing within Slack channels.

Microsoft Teams

Share and preview Confluence pages within Microsoft Teams with native connector support.

Trello

Link Trello boards to Confluence spaces for project documentation aligned with Kanban workflows.

Bitbucket

Embed Bitbucket code snippets and repository information in Confluence pages using Smart Links.

Solutions

Team Knowledge Base

Create a structured team knowledge base with organized spaces, nested pages, and templates for documentation.

Technical Documentation

Maintain living technical documentation alongside development workflows with API-driven updates.

Project Collaboration

Facilitate project planning, retrospectives, and cross-team collaboration with integrated Jira and Confluence workspaces.

Resources

Documentation

GettingStarted

Authentication

TermsOfService

PrivacyPolicy

GitHubOrganization

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Atlassian Confluence Cloud REST API (v1 and v2)
  version: '2.0'
items:
- info:
    name: Search (v1)
    type: folder
  items:
  - info:
      name: Search content using CQL
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/rest/api/content/search
      params:
      - name: cql
        value: ''
        type: query
      - name: cqlcontext
        value: ''
        type: query
      - name: cursor
        value: ''
        type: query
      - name: expand
        value: ''
        type: query
      - name: start
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: includeArchivedSpaces
        value: ''
        type: query
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Search content using CQL
- info:
    name: Content (v1)
    type: folder
  items:
  - info:
      name: Archive one or more pages
      type: http
    http:
      method: POST
      url: https://your-domain.atlassian.net/wiki/rest/api/content/archive
      body:
        type: json
        data: '{}'
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Archive one or more pages
  - info:
      name: Publish a legacy draft created from a blueprint
      type: http
    http:
      method: POST
      url: https://your-domain.atlassian.net/wiki/rest/api/content/blueprint/instance/:draftId
      params:
      - name: draftId
        value: ''
        type: path
      - name: status
        value: ''
        type: query
      - name: expand
        value: ''
        type: query
      body:
        type: json
        data: '{}'
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Publish a legacy draft created from a blueprint
  - info:
      name: Publish a shared draft created from a blueprint
      type: http
    http:
      method: PUT
      url: https://your-domain.atlassian.net/wiki/rest/api/content/blueprint/instance/:draftId
      params:
      - name: draftId
        value: ''
        type: path
      - name: status
        value: ''
        type: query
      - name: expand
        value: ''
        type: query
      body:
        type: json
        data: '{}'
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Publish a shared draft created from a blueprint
- info:
    name: Pages (v2)
    type: folder
  items:
  - info:
      name: List pages
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/api/v2/pages
      params:
      - name: id
        value: ''
        type: query
      - name: space-id
        value: ''
        type: query
      - name: sort
        value: ''
        type: query
      - name: status
        value: ''
        type: query
      - name: title
        value: ''
        type: query
      - name: body-format
        value: ''
        type: query
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: List pages
  - info:
      name: Create a page
      type: http
    http:
      method: POST
      url: https://your-domain.atlassian.net/wiki/api/v2/pages
      params:
      - name: embedded
        value: ''
        type: query
      - name: private
        value: ''
        type: query
      - name: root-level
        value: ''
        type: query
      body:
        type: json
        data: '{}'
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Create a page
  - info:
      name: Get a page
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/api/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
      - name: body-format
        value: ''
        type: query
      - name: get-draft
        value: ''
        type: query
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Get a page
  - info:
      name: Update a page
      type: http
    http:
      method: PUT
      url: https://your-domain.atlassian.net/wiki/api/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Update a page
  - info:
      name: Delete a page
      type: http
    http:
      method: DELETE
      url: https://your-domain.atlassian.net/wiki/api/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Delete a page
  - info:
      name: Update only the page title
      type: http
    http:
      method: PUT
      url: https://your-domain.atlassian.net/wiki/api/v2/pages/:id/title
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Update only the page title
- info:
    name: Spaces (v2)
    type: folder
  items:
  - info:
      name: List spaces
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/api/v2/spaces
      params:
      - name: ids
        value: ''
        type: query
      - name: keys
        value: ''
        type: query
      - name: type
        value: ''
        type: query
      - name: status
        value: ''
        type: query
      - name: labels
        value: ''
        type: query
      - name: sort
        value: ''
        type: query
      - name: description-format
        value: ''
        type: query
      - name: include-icon
        value: ''
        type: query
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: List spaces
  - info:
      name: Create a space
      type: http
    http:
      method: POST
      url: https://your-domain.atlassian.net/wiki/api/v2/spaces
      body:
        type: json
        data: '{}'
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Create a space
  - info:
      name: Get a space
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/api/v2/spaces/:id
      params:
      - name: id
        value: ''
        type: path
      - name: description-format
        value: ''
        type: query
      - name: include-icon
        value: ''
        type: query
      - name: include-operations
        value: ''
        type: query
      - name: include-properties
        value: ''
        type: query
      - name: include-permissions
        value: ''
        type: query
      - name: include-role-assignments
        value: ''
        type: query
      - name: include-labels
        value: ''
        type: query
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Get a space
  - info:
      name: List pages in a space
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/api/v2/spaces/:id/pages
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: List pages in a space
- info:
    name: Labels (v2)
    type: folder
  items:
  - info:
      name: List pages with the given label
      type: http
    http:
      method: GET
      url: https://your-domain.atlassian.net/wiki/api/v2/labels/:id/pages
      params:
      - name: id
        value: ''
        type: path
      - name: space-id
        value: ''
        type: query
      - name: body-format
        value: ''
        type: query
      - name: sort
        value: ''
        type: query
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: List pages with the given label
bundled: true