Confluence

APIs for Atlassian Confluence - team collaboration and knowledge management software.

62 APIs 16 Features

CollaborationContent ManagementDocumentationKnowledge BaseWiki

APIs

Confluence Cloud REST API v1

Primary REST API for Confluence Cloud for content, spaces, and user management.

Confluence Cloud REST API v2

Next generation Confluence Cloud REST API with improved performance and new features.

Confluence Content Properties API

Store and retrieve custom data against Confluence content.

Confluence Search API

Search for content in Confluence using CQL (Confluence Query Language).

Confluence Content API

Create, read, update, delete, and archive content including pages and blog posts in Confluence Cloud.

Confluence Space API

Manage Confluence spaces including creation, configuration, permissions, and settings.

Confluence Content Labels API

Add, remove, and manage labels on Confluence content for organization and discovery.

Confluence Analytics API

Retrieve analytics data including content views and viewer counts for Confluence Cloud.

Confluence Audit API

Access and manage audit log records for compliance and security tracking in Confluence Cloud.

Confluence Template API

Manage content templates and blueprints for standardized page creation in Confluence Cloud.

Confluence Group API

Manage user groups and group membership in Confluence Cloud.

Confluence Users API

Retrieve user information, manage user properties, and check permissions in Confluence Cloud.

Confluence Content States API

Manage content workflow states such as draft, in progress, and review in Confluence Cloud.

Confluence Content Restrictions API

Manage read and update restrictions on Confluence content for access control.

Confluence Space Permissions API

Manage permissions for Confluence spaces including user and group access levels.

Confluence GraphQL API

Query Confluence data using GraphQL for efficient cross-product data retrieval with field-level precision.

Confluence Data Center REST API

REST API for Confluence Data Center and Server for on-premise content, space, and user management.

Confluence Content Attachments API

Upload, retrieve, update, and delete file attachments on Confluence content.

Confluence Content Body API

Convert content body representations between storage, editor, view, and export formats.

Confluence Content Children and Descendants API

Retrieve children and descendants of Confluence content for navigating content hierarchies.

Confluence Content Macro Body API

Retrieve the body of a macro in Confluence content by macro ID.

Confluence Content Permissions API

Check content permissions for users to determine read and update access.

Confluence Content Versions API

Manage content version history including retrieval, restoration, and deletion of versions.

Confluence Content Watches API

Manage content and space watches to receive notifications on updates.

Confluence Dynamic Modules API

Confluence Experimental API

Experimental endpoints for Confluence Cloud that may change or be removed.

Confluence Label Info API

Retrieve information about labels used across Confluence content.

Confluence Long-Running Task API

Monitor the status and results of long-running asynchronous tasks in Confluence.

Confluence Relation API

Manage relationships between Confluence entities such as content and users.

Confluence Settings API

Retrieve and manage Confluence site settings and configuration.

Confluence Space Settings API

Manage settings for individual Confluence spaces.

Confluence Themes API

Retrieve theme information for Confluence spaces and the global site.

Confluence User Properties API

Store and retrieve custom properties associated with Confluence users.

Confluence V2 Page API

Create, retrieve, update, and delete pages using the Confluence Cloud REST API v2.

Confluence V2 Blog Post API

Create, retrieve, update, and delete blog posts using the Confluence Cloud REST API v2.

Confluence V2 Space API

Retrieve and manage spaces using the Confluence Cloud REST API v2.

Confluence V2 Comment API

Create, retrieve, update, and delete comments on pages and blog posts using the v2 API.

Confluence V2 Attachment API

Manage file attachments on content using the Confluence Cloud REST API v2.

Confluence V2 Label API

Manage labels on content using the Confluence Cloud REST API v2.

Confluence V2 Task API

Retrieve and manage tasks within Confluence content using the v2 API.

Confluence V2 Whiteboard API

Create and manage whiteboards in Confluence using the v2 API.

Confluence V2 Custom Content API

Create and manage custom content types in Confluence using the v2 API.

Confluence V2 Ancestors API

Retrieve ancestor pages in the content hierarchy using the v2 API.

Confluence V2 Children API

Retrieve child pages and content in the hierarchy using the v2 API.

Confluence V2 Descendants API

Retrieve all descendant pages in the content hierarchy using the v2 API.

Confluence V2 Version API

Manage content versions and version history using the v2 API.

Confluence V2 Like API

Manage likes on Confluence content using the v2 API.

Confluence V2 Space Permissions API

Manage space-level permissions using the Confluence Cloud REST API v2.

Confluence V2 Space Properties API

Store and retrieve custom properties on Confluence spaces using the v2 API.

Confluence V2 Space Roles API

Manage roles assigned to users and groups within Confluence spaces using the v2 API.

Confluence V2 Content Properties API

Store and manage custom properties on content using the Confluence Cloud REST API v2.

Confluence V2 Folder API

Create and manage folders for organizing pages in Confluence using the v2 API.

Confluence V2 Database API

Create and manage databases in Confluence using the v2 API.

Confluence V2 Smart Link API

Manage smart links for rich content previews in Confluence using the v2 API.

Confluence V2 Operation API

Check permitted operations on content using the Confluence Cloud REST API v2.

Confluence V2 User API

Retrieve user information and details using the Confluence Cloud REST API v2.

Confluence V2 App Properties API

Store and retrieve app-specific properties in Confluence using the v2 API.

Confluence V2 Content API

Manage content including conversions and permissions using the Confluence Cloud REST API v2.

Confluence V2 Data Policies API

Retrieve data policy information for Confluence workspaces using the v2 API.

Confluence V2 Classification Level API

Manage content classification levels for data protection in Confluence using the v2 API.

Confluence V2 Redactions API

Manage content redactions for sensitive information in Confluence using the v2 API.

Confluence V2 Admin Key API

Manage admin API keys for Confluence Cloud using the v2 API.

Collections

Confluence Cloud REST API v2

OPEN

GraphQL

Confluence GraphQL API

Query Confluence data using GraphQL for efficient cross-product data retrieval with field-level precision.

GRAPHQL

Pricing Plans

Confluence Plans Pricing

4 plans

PLANS

Rate Limits

Confluence Rate Limits

2 limits

RATE LIMITS

FinOps

Confluence Finops

FINOPS

Features

Free: up to 10 users, 2 GB storage

Standard: $6.05/user/mo with 250 GB storage

Premium: $11.55/user/mo with unlimited storage and analytics

Enterprise typically $23-$25/user/mo with AI, 99.95% uptime

REST API at api.atlassian.com/wiki

Rate limit ~10 req/sec/app/user

Bulk operations max 100 items/request

Pages, blog posts, comments, attachments, spaces APIs

Webhooks for content changes

OAuth 2.0 (3LO) and API tokens

CQL (Confluence Query Language) for search

Atlassian Connect framework for marketplace apps

Forge for serverless app development

Atlassian Intelligence (Enterprise)

Page tree, macros, templates, smart links

External collaboration via guest access

Use Cases

Knowledge Base

Build and maintain internal knowledge bases for teams with structured content and search.

Project Documentation

Create and collaborate on project documentation with version tracking and approvals.

Content Migration

Programmatically migrate content between Confluence instances or from other platforms.

Compliance and Auditing

Track content changes, manage access controls, and maintain audit trails.

Automated Publishing

Generate and publish content programmatically from CI/CD pipelines or other systems.

Integrations

Jira

Link Confluence pages to Jira issues for seamless project management workflows.

Slack

Receive Confluence notifications and preview pages directly in Slack channels.

Microsoft Teams

Collaborate on Confluence content within Microsoft Teams conversations.

Trello

Embed Trello boards in Confluence pages and link cards to documentation.

GitHub

Embed code snippets and link repositories to Confluence documentation.

Event Specifications

Confluence Cloud Webhooks

Asynchronous event notifications from Confluence Cloud. Webhooks allow applications to receive real-time notifications when content, spaces, or other entities are created, updat...

ASYNCAPI

Semantic Vocabularies

Confluence Cloud V2 Context

0 classes · 0 properties

JSON-LD

Confluence Context

0 classes · 8 properties

JSON-LD

API Governance Rules

Confluence API Rules

7 rules · 7 errors

1 fields

EXAMPLE

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Confluence Cloud REST API v2
  version: 2.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Page
    type: folder
  items:
  - info:
      name: Get Pages
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages
      params:
      - name: id
        value: ''
        type: query
        description: Filter by page IDs. Multiple IDs can be specified as comma-separated values.
      - name: space-id
        value: ''
        type: query
        description: Filter by space ID. Multiple IDs can be specified.
      - name: status
        value: ''
        type: query
        description: Filter by content status.
      - name: title
        value: ''
        type: query
        description: Filter by content title. Supports exact match.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: sort
        value: ''
        type: query
        description: Sort order for results. Prefix with - for descending order. Supported fields include id, title, created-date,
          and modified-date.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns all pages. The number of results is limited by the limit parameter and additional results can be retrieved
      via the next cursor. Results can be filtered by space, status, title, and body format.
  - info:
      name: Create Page
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/wiki/api/v2/pages
      body:
        type: json
        data: '{}'
    docs: Creates a page in the space. Pages can be created as a child of another page by specifying the parentId. Pages are
      created in the current status (draft or current).
  - info:
      name: Get Page by Id
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: get-draft
        value: ''
        type: query
        description: If true, returns the draft version of the page.
      - name: version
        value: ''
        type: query
        description: The version number of the content to retrieve.
    docs: Returns a specific page. The response includes the page body in the requested format, version information, and links.
  - info:
      name: Update Page
      type: http
    http:
      method: PUT
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      body:
        type: json
        data: '{}'
    docs: Updates a page by id. The request body must include the current version number, the new title, the space id, the
      status, and the body in the specified representation.
  - info:
      name: Delete Page
      type: http
    http:
      method: DELETE
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: purge
        value: 'true'
        type: query
        description: If true, the page is permanently deleted instead of moved to trash.
    docs: Deletes a page by id. By default pages are moved to trash. To purge a page permanently, set the purge parameter
      to true.
  - info:
      name: Get Child Pages
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id/children
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
      - name: sort
        value: ''
        type: query
        description: Sort order for results. Prefix with - for descending order. Supported fields include id, title, created-date,
          and modified-date.
    docs: Returns the child pages of a specific page, ordered by position in the page tree.
  - info:
      name: Get Pages in Space
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/spaces/:id/pages
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the space.
      - name: depth
        value: all
        type: query
        description: Filter by depth in the page tree. Use root to get only top-level pages.
      - name: status
        value: ''
        type: query
        description: Filter by content status.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: sort
        value: ''
        type: query
        description: Sort order for results. Prefix with - for descending order. Supported fields include id, title, created-date,
          and modified-date.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns all pages in a specific space. Supports filtering by status and depth.
- info:
    name: Label
    type: folder
  items:
  - info:
      name: Get Labels for Page
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id/labels
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: prefix
        value: ''
        type: query
        description: Filter labels by prefix (global, my, team).
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns the labels associated with a specific page.
  - info:
      name: Get Label by Id
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/labels/:id
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the label.
    docs: Returns a specific label by id.
- info:
    name: Space
    type: folder
  items:
  - info:
      name: Get Spaces
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/spaces
      params:
      - name: ids
        value: ''
        type: query
        description: Filter by space IDs. Multiple IDs can be specified as comma-separated values.
      - name: keys
        value: ''
        type: query
        description: Filter by space keys. Multiple keys can be specified as comma-separated values.
      - name: type
        value: global
        type: query
        description: Filter by space type.
      - name: status
        value: current
        type: query
        description: Filter by space status.
      - name: labels
        value: ''
        type: query
        description: Filter by space labels. Multiple labels can be specified.
      - name: sort
        value: ''
        type: query
        description: Sort order for results. Prefix with - for descending order. Supported fields include id, title, created-date,
          and modified-date.
      - name: description-format
        value: ''
        type: query
        description: The format of the space description in the response.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns all spaces. The results can be filtered by space type, status, and labels. Pagination is cursor-based.
  - info:
      name: Get Space by Id
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/spaces/:id
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the space.
      - name: description-format
        value: ''
        type: query
        description: The format of the space description in the response.
    docs: Returns a specific space by its id.
- info:
    name: Comment
    type: folder
  items:
  - info:
      name: Get Footer Comments for Page
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id/footer-comments
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns the footer comments of a specific page.
  - info:
      name: Get Inline Comments for Page
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id/inline-comments
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns the inline comments of a specific page.
  - info:
      name: Create Footer Comment
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/wiki/api/v2/footer-comments
      body:
        type: json
        data: '{}'
    docs: Creates a footer comment on a page or blog post.
  - info:
      name: Create Inline Comment
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/wiki/api/v2/inline-comments
      body:
        type: json
        data: '{}'
    docs: Creates an inline comment on a page or blog post. Inline comments are anchored to a specific text selection.
  - info:
      name: Get Comment by Id
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/comments/:id
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the comment.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: version
        value: ''
        type: query
        description: The version number of the content to retrieve.
    docs: Returns a specific comment by id.
  - info:
      name: Update Comment
      type: http
    http:
      method: PUT
      url: https://{domain}.atlassian.net/wiki/api/v2/comments/:id
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the comment.
      body:
        type: json
        data: '{}'
    docs: Updates a comment by id. The version number must be incremented.
  - info:
      name: Delete Comment
      type: http
    http:
      method: DELETE
      url: https://{domain}.atlassian.net/wiki/api/v2/comments/:id
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the comment.
    docs: Deletes a comment by id.
  - info:
      name: Get Child Comments
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/comments/:id/children
      params:
      - name: id
        value: abc123
        type: path
        description: The ID of the parent comment.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns the child (reply) comments of a specific comment.
- info:
    name: Blog Post
    type: folder
  items:
  - info:
      name: Get Blog Posts
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/blogposts
      params:
      - name: space-id
        value: ''
        type: query
        description: Filter by space ID. Multiple IDs can be specified.
      - name: status
        value: ''
        type: query
        description: Filter by content status.
      - name: title
        value: ''
        type: query
        description: Filter by content title. Supports exact match.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: sort
        value: ''
        type: query
        description: Sort order for results. Prefix with - for descending order. Supported fields include id, title, created-date,
          and modified-date.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns all blog posts. Results can be filtered by space, status, and title.
  - info:
      name: Create Blog Post
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/wiki/api/v2/blogposts
      body:
        type: json
        data: '{}'
    docs: Creates a blog post in the specified space.
  - info:
      name: Get Blog Post by Id
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/blogposts/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: body-format
        value: ''
        type: query
        description: The representation format for the content body.
      - name: version
        value: ''
        type: query
        description: The version number of the content to retrieve.
    docs: Returns a specific blog post by id.
  - info:
      name: Update Blog Post
      type: http
    http:
      method: PUT
      url: https://{domain}.atlassian.net/wiki/api/v2/blogposts/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      body:
        type: json
        data: '{}'
    docs: Updates a blog post by id.
  - info:
      name: Delete Blog Post
      type: http
    http:
      method: DELETE
      url: https://{domain}.atlassian.net/wiki/api/v2/blogposts/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
    docs: Deletes a blog post by id.
- info:
    name: Attachment
    type: folder
  items:
  - info:
      name: Get Attachment by Id
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/attachments/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
    docs: Returns a specific attachment by id.
  - info:
      name: Delete Attachment
      type: http
    http:
      method: DELETE
      url: https://{domain}.atlassian.net/wiki/api/v2/attachments/:id
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
    docs: Deletes an attachment by id.
  - info:
      name: Get Attachments for Page
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/wiki/api/v2/pages/:id/attachments
      params:
      - name: id
        value: ''
        type: path
        description: The ID of the content.
      - name: cursor
        value: ''
        type: query
        description: Used for pagination. The cursor value is returned in the response _links.next when there are more results.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results to return.
    docs: Returns the attachments of a specific page.
bundled: true