Confluence connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Confluence credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Scalekit environment with the Confluence connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:

   1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Confluence and click Create. Copy the redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

        

      • In the Atlassian Developer Console, open your app and go to Authorization → OAuth 2.0 (3LO) → Configure.

      • Paste the copied URI into the Callback URL field and click Save changes.

        

   2. Get client credentials

      In the Atlassian Developer Console, open your app and go to Settings:

      • Client ID — listed under Client ID
      • Client Secret — listed under Secret

   3. Add credentials in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.

      • Enter your credentials:

        • Client ID (from your Atlassian app settings)
        • Client Secret (from your Atlassian app settings)
        • Permissions (scopes — see Confluence OAuth scopes reference)

        

      • Click Save.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'confluence'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Confluence:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'confluence_attachments_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "confluence"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Confluence:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="confluence_attachments_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Get whiteboard, whiteboard descendants, whiteboard children — Retrieve a single Confluence whiteboard by its ID
• Delete whiteboard, space role, inline comment — Delete a Confluence whiteboard by its ID
• Create whiteboard, space role, space — Create a new whiteboard in a specified Confluence space
• Lookup users bulk — Look up user details in bulk for a list of account IDs
• Update task, space role, page title — Update a Confluence task by ID
• List task, space roles, space role assignments — List all Confluence tasks the current user has permission to view

Common workflows

Proxy API call

Don’t worry about the Confluence cloud ID in the path. Scalekit automatically resolves {{cloud_id}} from the connected account’s configuration. For example, a request with path="/wiki/rest/api/user/current" will be sent to https://api.atlassian.com/ex/confluence/a1b2c3d4-e5f6-7890-abcd-ef1234567890/wiki/rest/api/user/current automatically.

Node.js

const result = await actions.request({
  connectionName: 'confluence',
  identifier: 'user_123',
  path: '/wiki/rest/api/user/current',
  method: 'GET',
});
console.log(result);

Python

result = actions.request(
    connection_name='confluence',
    identifier='user_123',
    path="/wiki/rest/api/user/current",
    method="GET"
)
print(result)

Execute a tool

Node.js

const result = await actions.executeTool({
  connector: 'confluence',
  identifier: 'user_123',
  toolName: 'confluence_list',
  toolInput: {},
});
console.log(result);

Python

result = actions.execute_tool(
    tool_input={},
    tool_name='confluence_list',
    connection_name='confluence',
    identifier='user_123',
)
print(result)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

confluence_access_by_email_check#Check site access for a list of emails. Returns the subset of emails from the input list that do NOT currently have access to the Confluence site. Requires permission to access the Confluence site.1 param▾

Check site access for a list of emails. Returns the subset of emails from the input list that do NOT currently have access to the Confluence site. Requires permission to access the Confluence site.

NameTypeRequiredDescription

emailsarrayrequiredJSON array of email addresses to check for site access

confluence_access_by_email_invite#Invite a list of emails to the Confluence site. Invalid emails are ignored and no action is taken for emails that already have access. This API is asynchronous and may take some time to complete. Requires permission to access the Confluence site.1 param▾

Invite a list of emails to the Confluence site. Invalid emails are ignored and no action is taken for emails that already have access. This API is asynchronous and may take some time to complete. Requires permission to access the Confluence site.

NameTypeRequiredDescription

emailsarrayrequiredJSON array of email addresses to invite to the site

confluence_attachment_comments_get#Retrieve footer comments for a specific Confluence attachment. Returns paginated comment results including author, content, creation time, and reply counts. Supports cursor-based pagination and optional body format, and can retrieve comments for a specific attachment version.6 params▾

Retrieve footer comments for a specific Confluence attachment. Returns paginated comment results including author, content, creation time, and reply counts. Supports cursor-based pagination and optional body format, and can retrieve comments for a specific attachment version.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment for which comments should be returned

body_formatstringoptionalThe content format type to be returned in the body field of the response

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of comments to return per page (default 25, max 250)

sortstringoptionalSort order for comments (e.g. created-date, -created-date, modified-date, -modified-date)

versionintegeroptionalVersion number of the attachment to retrieve comments for. If not provided, retrieves comments for the latest version.

confluence_attachment_delete#Delete a Confluence attachment by its ID. By default moves the attachment to the trash; set purge=true to permanently delete a trashed attachment without recovery. This action requires permission to delete attachments in the space, and space admin permission to purge.2 params▾

Delete a Confluence attachment by its ID. By default moves the attachment to the trash; set purge=true to permanently delete a trashed attachment without recovery. This action requires permission to delete attachments in the space, and space admin permission to purge.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment to delete

purgebooleanoptionalSet to true to permanently delete a trashed attachment, bypassing recovery

confluence_attachment_get#Retrieve a specific Confluence attachment by its ID. Returns metadata including filename, media type, file size, download URL, and optionally labels, content properties, operations, versions, and collaborators. Use the Get Attachments tool if you don't know the attachment ID.8 params▾

Retrieve a specific Confluence attachment by its ID. Returns metadata including filename, media type, file size, download URL, and optionally labels, content properties, operations, versions, and collaborators. Use the Get Attachments tool if you don't know the attachment ID.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment to retrieve

include_collaboratorsbooleanoptionalSet to true to include collaborators on the attachment

include_labelsbooleanoptionalSet to true to include labels associated with this attachment

include_operationsbooleanoptionalSet to true to include operations associated with this attachment

include_propertiesbooleanoptionalSet to true to include content properties associated with this attachment

include_versionbooleanoptionalSet to false to exclude the current version details from the response

include_versionsbooleanoptionalSet to true to include all versions associated with this attachment

versionintegeroptionalSpecific version number of the attachment to retrieve (defaults to latest)

confluence_attachment_labels_get#Retrieve all labels attached to a specific Confluence attachment. Labels can be filtered by prefix (e.g. global, my, team, system). Returns a paginated list of label names and prefixes. Only labels the caller has permission to view are returned.5 params▾

Retrieve all labels attached to a specific Confluence attachment. Labels can be filtered by prefix (e.g. global, my, team, system). Returns a paginated list of label names and prefixes. Only labels the caller has permission to view are returned.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment whose labels to retrieve

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of labels to return per page (default 25, max 250)

prefixstringoptionalFilter labels by prefix (e.g. my, team, global, system)

sortstringoptionalSort order for labels (e.g. created-date, -created-date, id, -id, name, -name)

confluence_attachment_thumbnail_get#Download an attachment's thumbnail image by attachment ID. Redirects to a URL that serves the thumbnail's binary data. Optionally control the thumbnail dimensions or retrieve a previous version. Requires permission to view the attachment's container.4 params▾

Download an attachment's thumbnail image by attachment ID. Redirects to a URL that serves the thumbnail's binary data. Optionally control the thumbnail dimensions or retrieve a previous version. Requires permission to view the attachment's container.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment whose thumbnail is to be returned

heightintegeroptionalAllows you to define the thumbnail height

versionintegeroptionalAllows you to retrieve a previously published version. Specify the previous version's number to retrieve its details

widthintegeroptionalAllows you to define the thumbnail width

confluence_attachment_version_get#Retrieve the version details for a specific version of a Confluence attachment. Returns metadata about that version, including author and modification date. Use the Get Attachment Versions tool to list available version numbers first.2 params▾

Retrieve the version details for a specific version of a Confluence attachment. Returns metadata about that version, including author and modification date. Use the Get Attachment Versions tool to list available version numbers first.

NameTypeRequiredDescription

attachment_idstringrequiredThe ID of the attachment for which version details should be returned

version_numberintegerrequiredThe version number of the attachment to be returned

confluence_attachment_versions_get#Retrieve the version history of a specific Confluence attachment. Returns a paginated list of versions including version numbers, authors, and modification dates. Use the Get Attachment Version Details tool to fetch full details for a single version.4 params▾

Retrieve the version history of a specific Confluence attachment. Returns a paginated list of versions including version numbers, authors, and modification dates. Use the Get Attachment Version Details tool to fetch full details for a single version.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment whose versions to retrieve

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of versions to return per page (default 25, max 250)

sortstringoptionalSort order for versions (e.g. modified-date, -modified-date)

confluence_attachments_list#List all attachments across the Confluence instance. Returns a paginated collection of attachments with metadata including filename, media type, file size, and download URL. Supports filtering by status, media type, or filename and cursor-based pagination.6 params▾

List all attachments across the Confluence instance. Returns a paginated collection of attachments with metadata including filename, media type, file size, and download URL. Supports filtering by status, media type, or filename and cursor-based pagination.

NameTypeRequiredDescription

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

filenamestringoptionalFilter attachments by exact filename

limitintegeroptionalMaximum number of attachments to return per page (default 50, max 250)

media_typestringoptionalFilter attachments by MIME media type (e.g. image/png, application/pdf)

sortstringoptionalSort order for attachments (e.g. created-date, -created-date, modified-date, -modified-date)

statusarrayoptionalFilter attachments by status (current, archived, trashed). By default current and archived are returned.

confluence_blogpost_attachments_get#Retrieve all attachments on a Confluence blog post. Returns a paginated list of attachments with metadata including filename, media type, file size, and download URL. Supports filtering by status, media type, or filename and cursor-based pagination.7 params▾

Retrieve all attachments on a Confluence blog post. Returns a paginated list of attachments with metadata including filename, media type, file size, and download URL. Supports filtering by status, media type, or filename and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post for which attachments should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

filenamestringoptionalFilter attachments by exact filename

limitintegeroptionalMaximum number of attachments to return per page (default 50, max 250)

media_typestringoptionalFilter attachments by MIME media type (e.g. image/png, application/pdf)

sortstringoptionalSort order for attachments (e.g. created-date, -created-date, modified-date, -modified-date)

statusarrayoptionalFilter attachments by status (current, archived, trashed). By default current and archived are returned.

confluence_blogpost_create#Create a new blog post in a Confluence space. Requires a target space ID and a title. Optionally set the status (published or draft) and provide body content in storage or atlas_doc_format representation. Set the private query parameter to restrict visibility.6 params▾

Create a new blog post in a Confluence space. Requires a target space ID and a title. Optionally set the status (published or draft) and provide body content in storage or atlas_doc_format representation. Set the private query parameter to restrict visibility.

NameTypeRequiredDescription

spaceIdstringrequiredThe ID of the space to create the blog post in

titlestringrequiredTitle of the blog post

body_representationstringoptionalStorage format of the body content

body_valuestringoptionalThe content of the blog post body

privatebooleanoptionalWhether to create the blog post as private

statusstringoptionalPublication status of the blog post

confluence_blogpost_custom_content_list#Returns all custom content of a given type within a specific Confluence blog post. Custom content is app-defined content stored under a container such as a blog post. Results are paginated via cursor; use the type parameter to filter to a specific custom content type.6 params▾

Returns all custom content of a given type within a specific Confluence blog post. Custom content is app-defined content stored under a container such as a blog post. Results are paginated via cursor; use the type parameter to filter to a specific custom content type.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post for which custom content should be returned

typestringrequiredThe type of custom content being requested

body_formatstringoptionalThe content format to return in the body field of the response (e.g. raw, storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

limitintegeroptionalMaximum number of custom content items to return per page (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. id, -id, created-date, -created-date, modified-date, -modified-date, title, -title)

confluence_blogpost_delete#Delete a Confluence blog post by its ID. By default deletes non-draft blog posts, moving them to the trash where they can be restored later. Set draft=true to delete a draft blog post instead (discarded drafts are permanently deleted, not trashed). Set purge=true to permanently delete a trashed blog post without recovery.3 params▾

Delete a Confluence blog post by its ID. By default deletes non-draft blog posts, moving them to the trash where they can be restored later. Set draft=true to delete a draft blog post instead (discarded drafts are permanently deleted, not trashed). Set purge=true to permanently delete a trashed blog post without recovery.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post to delete

draftbooleanoptionalSet to true to delete a blog post that is a draft

purgebooleanoptionalSet to true to permanently delete a trashed blog post, bypassing recovery

confluence_blogpost_footer_comments_get#Retrieve the root footer comments of a specific Confluence blog post. Returns paginated comment results including author, content, and status. Supports sorting and cursor-based pagination.6 params▾

Retrieve the root footer comments of a specific Confluence blog post. Returns paginated comment results including author, content, and status. Supports sorting and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the blog post whose footer comments to retrieve

body_formatstringoptionalFormat of the comment body to include in the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of comments to return per page

sortstringoptionalSort order for the comments

statusarrayoptionalFilter footer comments by status. Accepts an array of values: current, deleted, trashed, historical, draft.

confluence_blogpost_get#Retrieve a specific Confluence blog post by its ID. Returns the blog post content, metadata, author, space, status, and version history. Optionally include body content in a specified format, fetch a draft version, or a historical version.5 params▾

Retrieve a specific Confluence blog post by its ID. Returns the blog post content, metadata, author, space, status, and version history. Optionally include body content in a specified format, fetch a draft version, or a historical version.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the blog post to retrieve

body_formatstringoptionalFormat of the blog post body to include in the response

get_draftbooleanoptionalWhether to retrieve the draft version of the blog post

include_labelsbooleanoptionalWhether to include labels applied to the blog post

versionintegeroptionalVersion number of the blog post to retrieve

confluence_blogpost_inline_comments_get#Retrieve the root inline comments of a specific Confluence blog post. Returns paginated comment results including author, content, and status. Supports filtering by status and resolution status, sorting, and cursor-based pagination.7 params▾

Retrieve the root inline comments of a specific Confluence blog post. Returns paginated comment results including author, content, and status. Supports filtering by status and resolution status, sorting, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the blog post whose inline comments to retrieve

body_formatstringoptionalFormat of the comment body to include in the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of inline comments to return per page

resolution_statusarrayoptionalFilter inline comments by resolution status. Accepts an array of values: resolved, open, dangling, reopened.

sortstringoptionalSort order for the comments

statusarrayoptionalFilter inline comments by status. Accepts an array of values: current, deleted, trashed, historical, draft.

confluence_blogpost_labels_get#Retrieve all labels attached to a Confluence blog post. Labels can be filtered by prefix (e.g. global, my, team, system). Returns a paginated list of label names and prefixes. Only labels the requesting user has permission to view are returned.5 params▾

Retrieve all labels attached to a Confluence blog post. Labels can be filtered by prefix (e.g. global, my, team, system). Returns a paginated list of label names and prefixes. Only labels the requesting user has permission to view are returned.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post for which labels should be returned

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

limitintegeroptionalMaximum number of labels to return per page (default 25, max 250)

prefixstringoptionalFilter the results to labels based on their prefix (e.g. my, team, global, system)

sortstringoptionalUsed to sort the result by a particular field (e.g. created-date, -created-date, id, -id, name, -name)

confluence_blogpost_like_count_get#Retrieve the total count of likes on a specific Confluence blog post.1 param▾

Retrieve the total count of likes on a specific Confluence blog post.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post for which like count should be returned

confluence_blogpost_like_users_get#Retrieve the account IDs of users who liked a specific Confluence blog post. Results are paginated via cursor.3 params▾

Retrieve the account IDs of users who liked a specific Confluence blog post. Results are paginated via cursor.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post for which account IDs of likes should be returned

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

limitintegeroptionalMaximum number of account IDs to return per page (default 25, max 250)

confluence_blogpost_list#List blog posts in Confluence. Filter by blog post IDs, space IDs, sort order, status, title, or body format. Returns paginated results with cursor-based navigation.8 params▾

List blog posts in Confluence. Filter by blog post IDs, space IDs, sort order, status, title, or body format. Returns paginated results with cursor-based navigation.

NameTypeRequiredDescription

body_formatstringoptionalFormat of the blog post body to return

cursorstringoptionalCursor token for fetching the next page of results

idarrayoptionalFilter by specific blog post IDs

limitintegeroptionalMaximum number of blog posts to return per page

sortstringoptionalSort order for the results

space_idarrayoptionalFilter blog posts by space IDs

statusstringoptionalFilter blog posts by status

titlestringoptionalFilter blog posts by title (partial match)

confluence_blogpost_update#Update an existing Confluence blog post. Requires the blog post ID, current status, title, and the next version number (must be exactly current version + 1). Optionally update the body content or add a version message. Retrieve the current version number with the Get Blog Post tool before calling this.7 params▾

Update an existing Confluence blog post. Requires the blog post ID, current status, title, and the next version number (must be exactly current version + 1). Optionally update the body content or add a version message. Retrieve the current version number with the Get Blog Post tool before calling this.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post to update

statusstringrequiredStatus of the blog post after the update (e.g. current, draft)

titlestringrequiredUpdated title of the blog post

version_numberintegerrequiredThe new version number for this update. Must be exactly the current version number plus 1.

body_representationstringoptionalFormat for the updated body content (e.g. storage, atlas_doc_format). Must be set together with body_value.

body_valuestringoptionalThe updated body content in the format specified by body_representation. Must be set together with body_representation.

version_messagestringoptionalOptional message describing what changed in this version

confluence_blogpost_version_get#Retrieve the details of a specific historical version of a Confluence blog post, identified by blog post ID and version number.2 params▾

Retrieve the details of a specific historical version of a Confluence blog post, identified by blog post ID and version number.

NameTypeRequiredDescription

blogpost_idstringrequiredThe ID of the blog post for which version details should be returned

version_numberintegerrequiredThe version number of the blog post to be returned

confluence_blogpost_versions_list#Retrieve the version history of a specific Confluence blog post. Returns a paginated list of versions with metadata such as author and modification date. Use cursor-based pagination for blog posts with many versions.5 params▾

Retrieve the version history of a specific Confluence blog post. Returns a paginated list of versions with metadata such as author and modification date. Use cursor-based pagination for blog posts with many versions.

NameTypeRequiredDescription

idstringrequiredThe ID of the blog post to be queried for its versions

body_formatstringoptionalThe content format to return in the body field of each version (e.g. storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

limitintegeroptionalMaximum number of versions to return per page (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. modified-date, -modified-date)

confluence_custom_content_attachments_get#Retrieve the attachments of a specific Confluence custom content item. Supports filtering by status, media type, or filename, and cursor-based pagination for items with many attachments.7 params▾

Retrieve the attachments of a specific Confluence custom content item. Supports filtering by status, media type, or filename, and cursor-based pagination for items with many attachments.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom content for which attachments should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

filenamestringoptionalFilter attachments by their filename (only one filename may be specified)

limitintegeroptionalMaximum number of attachments to return per page (default 50, max 250)

media_typestringoptionalFilter attachments by media type (only one media type may be specified)

sortstringoptionalSort order for attachments (e.g. created-date, -created-date, modified-date, -modified-date)

statusstringoptionalFilter attachments by status (comma-separated list). By default current and archived are used.

confluence_custom_content_children_get#Retrieve all child custom content for a given custom content ID. Results are paginated via cursor. Only custom content the user has permission to view is returned.4 params▾

Retrieve all child custom content for a given custom content ID. Results are paginated via cursor. Only custom content the user has permission to view is returned.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent custom content. If you don't know the custom content ID, use List Custom Content and filter the results

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of pages per result to return (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. created-date, -created-date, id, -id, modified-date, -modified-date)

confluence_custom_content_comments_get#Retrieve the footer comments of a specific Confluence custom content item. Supports body format selection and cursor-based pagination for items with many comments.5 params▾

Retrieve the footer comments of a specific Confluence custom content item. Supports body format selection and cursor-based pagination for items with many comments.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom content for which comments should be returned

body_formatstringoptionalThe content format to return in the body field of each comment (e.g. storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of comments to return per page (default 25, max 250)

sortstringoptionalSort order for comments (e.g. created-date, -created-date, modified-date, -modified-date)

confluence_custom_content_create#Create a new Confluence custom content item under a space, page, blog post, or other custom content. Exactly one of space_id, page_id, blog_post_id, or custom_content_id must be provided as the container. Requires a type and title; optionally set the initial status and body content.9 params▾

Create a new Confluence custom content item under a space, page, blog post, or other custom content. Exactly one of space_id, page_id, blog_post_id, or custom_content_id must be provided as the container. Requires a type and title; optionally set the initial status and body content.

NameTypeRequiredDescription

titlestringrequiredTitle of the new custom content

typestringrequiredThe app-defined type of custom content to create

blog_post_idstringoptionalThe ID of the blog post to create the custom content under. Provide exactly one of space_id, page_id, blog_post_id, or custom_content_id.

body_representationstringoptionalThe markup format for the custom content body (e.g. storage, atlas_doc_format). Must be set together with body_value.

body_valuestringoptionalThe raw content of the custom content body in the format specified by body_representation. Must be set together with body_representation.

custom_content_idstringoptionalThe ID of another custom content item to nest this custom content under. Provide exactly one of space_id, page_id, blog_post_id, or custom_content_id.

page_idstringoptionalThe ID of the page to create the custom content under. Provide exactly one of space_id, page_id, blog_post_id, or custom_content_id.

space_idstringoptionalThe ID of the space to create the custom content under. Provide exactly one of space_id, page_id, blog_post_id, or custom_content_id.

statusstringoptionalInitial status of the custom content (e.g. current, draft)

confluence_custom_content_delete#Delete a Confluence custom content item by its ID. By default moves the custom content to the trash; set purge=true to permanently delete a trashed item without recovery. This action is irreversible when purge is enabled.2 params▾

Delete a Confluence custom content item by its ID. By default moves the custom content to the trash; set purge=true to permanently delete a trashed item without recovery. This action is irreversible when purge is enabled.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom content to be deleted

purgebooleanoptionalSet to true to permanently delete an already-trashed custom content item, bypassing recovery

confluence_custom_content_get#Retrieve a specific piece of Confluence custom content by its ID. Optionally include labels, content properties, operations, version history, the current version, or collaborators in the response.9 params▾

Retrieve a specific piece of Confluence custom content by its ID. Optionally include labels, content properties, operations, version history, the current version, or collaborators in the response.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom content to be returned

body_formatstringoptionalThe content format to return in the body field of the response (e.g. raw, storage, atlas_doc_format, view, export_view, anonymous_export_view)

include_collaboratorsbooleanoptionalSet to true to include collaborators on the custom content

include_labelsbooleanoptionalSet to true to include labels associated with this custom content in the response

include_operationsbooleanoptionalSet to true to include operations associated with this custom content in the response

include_propertiesbooleanoptionalSet to true to include content properties associated with this custom content in the response

include_versionbooleanoptionalIncludes the current version associated with this custom content in the response. Defaults to true.

include_versionsbooleanoptionalSet to true to include versions associated with this custom content in the response

versionintegeroptionalAllows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

confluence_custom_content_labels_get#Retrieve all labels attached to a Confluence custom content item. Labels can be filtered by prefix (e.g. global, my, team, system). Returns a paginated list of label names and prefixes; only labels the user can view are returned.5 params▾

Retrieve all labels attached to a Confluence custom content item. Labels can be filtered by prefix (e.g. global, my, team, system). Returns a paginated list of label names and prefixes; only labels the user can view are returned.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom content for which labels should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of labels to return per page (default 25, max 250)

prefixstringoptionalFilter labels by prefix (e.g. my, team, global, system)

sortstringoptionalSort order for labels (e.g. created-date, -created-date, id, -id, name, -name)

confluence_custom_content_list#Returns all Confluence custom content for a given type, optionally filtered by custom content IDs or space IDs. Custom content is app-defined content that can live under a page, blog post, space, or other custom content. Results are paginated via cursor.7 params▾

Returns all Confluence custom content for a given type, optionally filtered by custom content IDs or space IDs. Custom content is app-defined content that can live under a page, blog post, space, or other custom content. Results are paginated via cursor.

NameTypeRequiredDescription

typestringrequiredThe type of custom content being requested

body_formatstringoptionalThe content format to return in the body field of the response (e.g. raw, storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

idstringoptionalFilter the results based on custom content IDs (comma-separated string, up to 250 IDs)

limitintegeroptionalMaximum number of custom content items to return per page (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. id, -id, created-date, -created-date, modified-date, -modified-date, title, -title)

space_idstringoptionalFilter the results based on space IDs (comma-separated string, up to 100 IDs)

confluence_custom_content_update#Update an existing Confluence custom content item by ID. Requires the current status, title, type, and the next version number (must be exactly current version + 1). At most one of space_id, page_id, blog_post_id, or custom_content_id may be set; if space_id is specified it must match the space used when the custom content was created, since moving custom content between spaces is not supported. Retrieve the current version number with the Get Custom Content tool before calling this.12 params▾

Update an existing Confluence custom content item by ID. Requires the current status, title, type, and the next version number (must be exactly current version + 1). At most one of space_id, page_id, blog_post_id, or custom_content_id may be set; if space_id is specified it must match the space used when the custom content was created, since moving custom content between spaces is not supported. Retrieve the current version number with the Get Custom Content tool before calling this.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom content to be updated

statusstringrequiredStatus of the custom content after the update (e.g. current, draft)

titlestringrequiredUpdated title of the custom content

typestringrequiredThe app-defined type of the custom content

version_numberintegerrequiredThe new version number for this update. Must be exactly the current version number plus 1.

blog_post_idstringoptionalThe ID of the blog post this custom content belongs to

body_representationstringoptionalFormat for the updated body content (e.g. storage, atlas_doc_format). Must be set together with body_value.

body_valuestringoptionalThe updated body content in the format specified by body_representation. Must be set together with body_representation.

custom_content_idstringoptionalThe ID of a parent custom content item this custom content belongs to

page_idstringoptionalThe ID of the page this custom content belongs to

space_idstringoptionalThe ID of the space this custom content belongs to. If specified, must match the space used when the custom content was created.

version_messagestringoptionalOptional message describing what changed in this version

confluence_custom_content_version_get#Retrieve version details for a specific version number of Confluence custom content.2 params▾

Retrieve version details for a specific version number of Confluence custom content.

NameTypeRequiredDescription

custom_content_idstringrequiredThe ID of the custom content for which version details should be returned

version_numberstringrequiredThe version number of the custom content to be returned

confluence_custom_content_versions_list#Retrieve the versions of specific Confluence custom content. Supports filtering the returned body format and cursor-based pagination.5 params▾

Retrieve the versions of specific Confluence custom content. Supports filtering the returned body format and cursor-based pagination.

NameTypeRequiredDescription

custom_content_idstringrequiredThe ID of the custom content to be queried for its versions

body_formatstringoptionalThe content format to be returned in the body field of the response (raw, storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of versions per result to return (default 25, max 250)

sortstringoptionalSort order for versions (modified-date or -modified-date)

confluence_database_ancestors_get#Retrieve all ancestors of a Confluence database in the content tree, in top-to-bottom order (the highest ancestor is first in the response). If more results exist, call again using the ID of the first ancestor returned.2 params▾

Retrieve all ancestors of a Confluence database in the content tree, in top-to-bottom order (the highest ancestor is first in the response). If more results exist, call again using the ID of the first ancestor returned.

NameTypeRequiredDescription

idstringrequiredThe ID of the database

limitintegeroptionalMaximum number of items to return (default 25, max 250)

confluence_database_create#Create a new Confluence smart-linked database (Database content type) in a specified space. Requires a space ID. Optionally set a title and a parent content ID. Set private=true to restrict visibility to the creator.4 params▾

Create a new Confluence smart-linked database (Database content type) in a specified space. Requires a space ID. Optionally set a title and a parent content ID. Set private=true to restrict visibility to the creator.

NameTypeRequiredDescription

space_idstringrequiredThe ID of the space in which to create the database

parent_idstringoptionalThe parent content ID of the database

privatebooleanoptionalSet to true to create the database as private, visible only to the creator

titlestringoptionalTitle of the database

confluence_database_delete#Delete a Confluence database by its ID. Deleting a database moves it to the trash, where it can be restored later. Requires permission to view the database and its corresponding space, and permission to delete databases in the space.1 param▾

Delete a Confluence database by its ID. Deleting a database moves it to the trash, where it can be restored later. Requires permission to view the database and its corresponding space, and permission to delete databases in the space.

NameTypeRequiredDescription

idstringrequiredThe ID of the database to be deleted

confluence_database_descendants_get#Retrieve descendants in the content tree for a Confluence database, in top-to-bottom order (the highest descendant is first in the response). Supports a depth parameter to limit how many levels of descendants are returned, and cursor-based pagination for additional results.4 params▾

Retrieve descendants in the content tree for a Confluence database, in top-to-bottom order (the highest descendant is first in the response). Supports a depth parameter to limit how many levels of descendants are returned, and cursor-based pagination for additional results.

NameTypeRequiredDescription

idstringrequiredThe ID of the database

cursorstringoptionalOpaque cursor for pagination, returned in the Link response header of a previous call

depthintegeroptionalMaximum depth of descendants to return (default 2, max 10)

limitintegeroptionalMaximum number of items to return per result (default 25, max 250)

confluence_database_direct_children_get#Retrieve the direct children of a Confluence database in the content tree (database, embed, folder, page, or whiteboard types). Returns minimal information about each child; use cursor-based pagination via the returned Link header to fetch more results.4 params▾

Retrieve the direct children of a Confluence database in the content tree (database, embed, folder, page, or whiteboard types). Returns minimal information about each child; use cursor-based pagination via the returned Link header to fetch more results.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent database

cursorstringoptionalOpaque cursor for pagination, returned in the Link response header of a previous call

limitintegeroptionalMaximum number of items to return per result (default 25, max 250)

sortstringoptionalField and direction to sort the results by. Valid values: created-date, -created-date, id, -id, modified-date, -modified-date, child-position, -child-position, title, -title

confluence_database_get#Retrieve a specific Confluence database (a Confluence Whiteboard-style structured database object) by its ID. Returns core database metadata and optionally its collaborators, direct children, operations, and content properties. Requires permission to view the database and its corresponding space.5 params▾

Retrieve a specific Confluence database (a Confluence Whiteboard-style structured database object) by its ID. Returns core database metadata and optionally its collaborators, direct children, operations, and content properties. Requires permission to view the database and its corresponding space.

NameTypeRequiredDescription

idstringrequiredThe ID of the database to be returned

include_collaboratorsbooleanoptionalSet to true to include collaborators on the database in the response

include_direct_childrenbooleanoptionalSet to true to include direct children of the database, as defined in the ChildrenResponse object

include_operationsbooleanoptionalSet to true to include operations associated with this database. Results are limited to 50 and sorted in default order

include_propertiesbooleanoptionalSet to true to include content properties associated with this database. Results are limited to 50 and sorted in default order

confluence_folder_ancestors_get#Retrieve all ancestors of a Confluence folder in top-to-bottom order (the highest ancestor first). Returns minimal information about each ancestor.2 params▾

Retrieve all ancestors of a Confluence folder in top-to-bottom order (the highest ancestor first). Returns minimal information about each ancestor.

NameTypeRequiredDescription

idstringrequiredThe ID of the folder

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

confluence_folder_create#Create a new folder in a Confluence space. Requires a space ID. Optionally set a title and a parent folder ID to nest the folder under another folder. Requires permission to view the corresponding space and permission to create a folder in the space.3 params▾

Create a new folder in a Confluence space. Requires a space ID. Optionally set a title and a parent folder ID to nest the folder under another folder. Requires permission to view the corresponding space and permission to create a folder in the space.

NameTypeRequiredDescription

space_idstringrequiredThe ID of the space in which to create the folder

parent_idstringoptionalID of the parent folder under which this folder will be created

titlestringoptionalTitle of the new folder

confluence_folder_delete#Delete a Confluence folder by its ID. Deleting a folder moves it to the trash, where it can be restored later.1 param▾

Delete a Confluence folder by its ID. Deleting a folder moves it to the trash, where it can be restored later.

NameTypeRequiredDescription

idstringrequiredThe ID of the folder to be deleted

confluence_folder_descendants_get#Retrieve descendants of a Confluence folder in the content tree, in top-to-bottom order. Returns database, embed, folder, page, and whiteboard content types. Control how deep to traverse with the depth parameter, and paginate with cursor.4 params▾

Retrieve descendants of a Confluence folder in the content tree, in top-to-bottom order. Returns database, embed, folder, page, and whiteboard content types. Control how deep to traverse with the depth parameter, and paginate with cursor.

NameTypeRequiredDescription

idstringrequiredThe ID of the folder

cursorstringoptionalCursor token for pagination, returned in the previous response

depthintegeroptionalMaximum depth of descendants to return (default 2, min 1, max 10)

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

confluence_folder_direct_children_get#Retrieve the direct children of a Confluence folder in the content tree. Returns minimal information about each child (database, embed, folder, page, or whiteboard). Use cursor-based pagination for folders with many children.4 params▾

Retrieve the direct children of a Confluence folder in the content tree. Returns minimal information about each child (database, embed, folder, page, or whiteboard). Use cursor-based pagination for folders with many children.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent folder

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

sortstringoptionalSort order for children (e.g. created-date, -created-date, id, -id, modified-date, -modified-date, child-position, -child-position, title, -title)

confluence_folder_get#Retrieve a specific Confluence folder by its ID. Returns core folder metadata and optionally its collaborators, direct children, operations, and content properties. Requires permission to view the folder and its corresponding space.5 params▾

Retrieve a specific Confluence folder by its ID. Returns core folder metadata and optionally its collaborators, direct children, operations, and content properties. Requires permission to view the folder and its corresponding space.

NameTypeRequiredDescription

idstringrequiredThe ID of the folder to be returned

include_collaboratorsbooleanoptionalSet to true to include collaborators on the folder in the response

include_direct_childrenbooleanoptionalSet to true to include direct children of the folder, as defined in the ChildrenResponse object

include_operationsbooleanoptionalSet to true to include operations associated with this folder. Results are limited to 50 and sorted in default order

include_propertiesbooleanoptionalSet to true to include content properties associated with this folder. Results are limited to 50 and sorted in default order

confluence_footer_comment_children_get#Retrieve the child (reply) footer comments of a specific Confluence footer comment. Returns paginated comment results. Supports sorting and cursor-based pagination.5 params▾

Retrieve the child (reply) footer comments of a specific Confluence footer comment. Returns paginated comment results. Supports sorting and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent footer comment whose children to retrieve

body_formatstringoptionalFormat of the comment body to include in the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of footer comments to return per page

sortstringoptionalSort order for the comments

confluence_footer_comment_create#Create a footer comment on a Confluence page, blog post, or as a reply to an existing comment. Requires body content with a representation format and exactly one parent target: pageId, blogPostId, or parentCommentId. Use pageId to comment on a page, blogPostId to comment on a blog post, and parentCommentId to reply to an existing comment.5 params▾

Create a footer comment on a Confluence page, blog post, or as a reply to an existing comment. Requires body content with a representation format and exactly one parent target: pageId, blogPostId, or parentCommentId. Use pageId to comment on a page, blogPostId to comment on a blog post, and parentCommentId to reply to an existing comment.

NameTypeRequiredDescription

body_representationstringrequiredStorage format of the comment body content

body_valuestringrequiredThe content of the comment

blogPostIdstringoptionalID of the blog post to attach this comment to

pageIdstringoptionalID of the page to attach this comment to

parentCommentIdstringoptionalID of the parent comment to reply to

confluence_footer_comment_delete#Permanently delete a Confluence footer comment by its ID. This action cannot be reverted.1 param▾

Permanently delete a Confluence footer comment by its ID. This action cannot be reverted.

NameTypeRequiredDescription

comment_idstringrequiredThe ID of the footer comment to delete

confluence_footer_comment_get#Retrieve a single Confluence footer comment by its ID. Returns the comment body, author, version, and status. Optionally set body_format to control the markup format returned, and specify version to retrieve a previously published version. Additional flags expose properties, operations, likes, and version history.8 params▾

Retrieve a single Confluence footer comment by its ID. Returns the comment body, author, version, and status. Optionally set body_format to control the markup format returned, and specify version to retrieve a previously published version. Additional flags expose properties, operations, likes, and version history.

NameTypeRequiredDescription

comment_idstringrequiredThe ID of the footer comment to retrieve

body_formatstringoptionalFormat for the returned comment body

include_likesbooleanoptionalSet to true to include likes associated with this footer comment

include_operationsbooleanoptionalSet to true to include operations associated with this footer comment

include_propertiesbooleanoptionalSet to true to include content properties associated with this footer comment

include_versionbooleanoptionalSet to true to include the current version information in the response (included by default)

include_versionsbooleanoptionalSet to true to include version history associated with this footer comment

versionintegeroptionalSpecific version number of the comment to retrieve (defaults to latest)

confluence_footer_comment_like_count_get#Retrieve the total count of likes on a specific Confluence footer comment.1 param▾

Retrieve the total count of likes on a specific Confluence footer comment.

NameTypeRequiredDescription

idstringrequiredThe ID of the footer comment for which like count should be returned

confluence_footer_comment_like_users_get#Retrieve the account IDs of users who liked a specific Confluence footer comment. Returns a paginated list of account IDs. Use the Get Footer Comments tool to find valid footer comment IDs.3 params▾

Retrieve the account IDs of users who liked a specific Confluence footer comment. Returns a paginated list of account IDs. Use the Get Footer Comments tool to find valid footer comment IDs.

NameTypeRequiredDescription

idstringrequiredThe ID of the footer comment for which like count should be returned

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of account IDs per result to return

confluence_footer_comment_update#Update an existing Confluence footer comment, typically to change its body text. Requires the new version number (current version + 1) and the new body content with representation format.4 params▾

Update an existing Confluence footer comment, typically to change its body text. Requires the new version number (current version + 1) and the new body content with representation format.

NameTypeRequiredDescription

body_representationstringrequiredStorage format of the updated comment body content

body_valuestringrequiredThe updated content of the comment

comment_idstringrequiredThe ID of the footer comment to update

version_numberintegerrequiredThe new version number for the comment. Must be the current version number plus one.

confluence_footer_comment_version_get#Retrieve the version details for a specific version of a Confluence footer comment. Returns metadata about that version, including author and modification date. Use the List Footer Comment Versions tool to list available version numbers first.2 params▾

Retrieve the version details for a specific version of a Confluence footer comment. Returns metadata about that version, including author and modification date. Use the List Footer Comment Versions tool to list available version numbers first.

NameTypeRequiredDescription

idstringrequiredThe ID of the footer comment for which version details should be returned

version_numberintegerrequiredThe version number of the footer comment to be returned

confluence_footer_comment_versions_list#Retrieve the version history of a specific Confluence footer comment. Returns a paginated list of versions with metadata such as author and modification date. Supports optional body format, cursor-based pagination, and sort order.5 params▾

Retrieve the version history of a specific Confluence footer comment. Returns a paginated list of versions with metadata such as author and modification date. Supports optional body format, cursor-based pagination, and sort order.

NameTypeRequiredDescription

idstringrequiredThe ID of the footer comment for which versions should be returned

body_formatstringoptionalThe content format type to be returned in the body field of the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of versions per result to return

sortstringoptionalSort order for the versions

confluence_footer_comments_get#Retrieve footer comments (inline comments at the bottom) for a specific Confluence page. Returns paginated comment results including author, content, creation time, and reply counts. Supports cursor-based pagination and optional body format.5 params▾

Retrieve footer comments (inline comments at the bottom) for a specific Confluence page. Returns paginated comment results including author, content, creation time, and reply counts. Supports cursor-based pagination and optional body format.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the page whose footer comments to retrieve

body_formatstringoptionalFormat of the comment body to include in the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of comments to return per page

sortstringoptionalSort order for the comments

confluence_footer_comments_list#Retrieve all footer comments across the Confluence instance, not scoped to a single page or blog post. Returns paginated comment results. Supports sorting and cursor-based pagination.4 params▾

Retrieve all footer comments across the Confluence instance, not scoped to a single page or blog post. Returns paginated comment results. Supports sorting and cursor-based pagination.

NameTypeRequiredDescription

body_formatstringoptionalFormat of the comment body to include in the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of footer comments to return per page

sortstringoptionalSort order for the comments

confluence_inline_comment_children_get#Retrieve the child (reply) inline comments of a specific Confluence inline comment. Returns a paginated list of replies. Supports optional body format, sort order, and cursor-based pagination.5 params▾

Retrieve the child (reply) inline comments of a specific Confluence inline comment. Returns a paginated list of replies. Supports optional body format, sort order, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent comment for which inline comment children should be returned

body_formatstringoptionalThe content format type to be returned in the body field of the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of child comments per result to return

sortstringoptionalSort order for the child comments

confluence_inline_comment_create#Create an inline comment on a Confluence page or blog post, or as a reply to an existing inline comment. Requires body content with a representation format and exactly one parent target: page_id, blogpost_id, or parent_comment_id. For top-level comments (page_id or blogpost_id), inline_comment_text_selection is required to specify the text to highlight.8 params▾

Create an inline comment on a Confluence page or blog post, or as a reply to an existing inline comment. Requires body content with a representation format and exactly one parent target: page_id, blogpost_id, or parent_comment_id. For top-level comments (page_id or blogpost_id), inline_comment_text_selection is required to specify the text to highlight.

NameTypeRequiredDescription

body_representationstringrequiredStorage format of the comment body content

body_valuestringrequiredThe content of the comment

blogpost_idstringoptionalID of the blog post to attach this inline comment to

inline_comment_text_selectionstringoptionalThe text on the page/blog post to highlight for this inline comment. Required for top-level inline comments (page_id or blogpost_id); not applicable for replies.

inline_comment_text_selection_match_countintegeroptionalThe number of matches for the selected text on the page. Should be strictly greater than inline_comment_text_selection_match_index.

inline_comment_text_selection_match_indexintegeroptionalThe zero-based match index of the selected text occurrence to highlight. For example, to highlight the second occurrence of 3 matches, pass 1 for this field and 3 for inline_comment_text_selection_match_count.

page_idstringoptionalID of the page to attach this inline comment to

parent_comment_idstringoptionalID of the parent inline comment to reply to

confluence_inline_comment_delete#Permanently delete a Confluence inline comment by its ID. This action cannot be reverted.1 param▾

Permanently delete a Confluence inline comment by its ID. This action cannot be reverted.

NameTypeRequiredDescription

comment_idstringrequiredThe ID of the comment to be deleted

confluence_inline_comment_get#Retrieve a single Confluence inline comment by its ID. Returns the comment body, resolved state, and highlighted text metadata. Optionally include content properties, operations, likes, and version information.8 params▾

Retrieve a single Confluence inline comment by its ID. Returns the comment body, resolved state, and highlighted text metadata. Optionally include content properties, operations, likes, and version information.

NameTypeRequiredDescription

comment_idstringrequiredThe ID of the comment to be retrieved

body_formatstringoptionalThe content format type to be returned in the body field of the response

include_likesbooleanoptionalIncludes likes associated with this inline comment in the response

include_operationsbooleanoptionalIncludes operations associated with this inline comment in the response

include_propertiesbooleanoptionalIncludes content properties associated with this inline comment in the response

include_versionbooleanoptionalIncludes the current version associated with this inline comment in the response. By default this is included.

include_versionsbooleanoptionalIncludes versions associated with this inline comment in the response

versionintegeroptionalAllows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

confluence_inline_comment_like_count_get#Retrieve the number of likes for a specific Confluence inline comment.1 param▾

Retrieve the number of likes for a specific Confluence inline comment.

NameTypeRequiredDescription

idstringrequiredThe ID of the inline comment for which like count should be returned

confluence_inline_comment_like_users_get#Retrieve the account IDs of users who liked a specific Confluence inline comment. Results are paginated via cursor.3 params▾

Retrieve the account IDs of users who liked a specific Confluence inline comment. Results are paginated via cursor.

NameTypeRequiredDescription

idstringrequiredThe ID of the inline comment for which account IDs of likes should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of account IDs to return per page (default 25, max 250)

confluence_inline_comment_update#Update an existing Confluence inline comment. Use this to change the body text and/or resolve or reopen the comment. Requires the new version number (one higher than the comment's current version).6 params▾

Update an existing Confluence inline comment. Use this to change the body text and/or resolve or reopen the comment. Requires the new version number (one higher than the comment's current version).

NameTypeRequiredDescription

comment_idstringrequiredThe ID of the comment to be updated

version_numberintegerrequiredNumber of the new version. Should be 1 higher than the current version of the comment.

body_representationstringoptionalStorage format of the comment body content. Must be set together with body_value.

body_valuestringoptionalThe new content of the comment. Must be set together with body_representation.

resolvedbooleanoptionalResolved state of the comment. Set to true to resolve the comment, set to false to reopen it. A dangling comment cannot be updated.

version_messagestringoptionalOptional message to store for the new version

confluence_inline_comment_version_get#Retrieve the version details for a specific version of a Confluence inline comment. Returns metadata about that version, including author and modification date. Use the Get Inline Comment Versions tool to list available version numbers first.2 params▾

Retrieve the version details for a specific version of a Confluence inline comment. Returns metadata about that version, including author and modification date. Use the Get Inline Comment Versions tool to list available version numbers first.

NameTypeRequiredDescription

idstringrequiredThe ID of the inline comment for which version details should be returned

version_numberintegerrequiredThe version number of the inline comment to be returned

confluence_inline_comment_versions_get#Retrieve the version history of a specific Confluence inline comment. Returns a paginated list of versions including version numbers, authors, and modification dates. Use the Get Inline Comment Version tool to fetch full details for a single version.5 params▾

Retrieve the version history of a specific Confluence inline comment. Returns a paginated list of versions including version numbers, authors, and modification dates. Use the Get Inline Comment Version tool to fetch full details for a single version.

NameTypeRequiredDescription

idstringrequiredThe ID of the inline comment for which versions should be returned

body_formatstringoptionalThe content format types to be returned in the body field of the response (e.g. storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of versions to return per page (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. modified-date, -modified-date)

confluence_inline_comments_list#Retrieve all inline comments across Confluence. Returns a paginated list of inline comments including author, content, and highlighted text metadata. Supports optional body format, sort order, and cursor-based pagination.4 params▾

Retrieve all inline comments across Confluence. Returns a paginated list of inline comments including author, content, and highlighted text metadata. Supports optional body format, sort order, and cursor-based pagination.

NameTypeRequiredDescription

body_formatstringoptionalThe content format type to be returned in the body field of the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of inline comments per result to return

sortstringoptionalSort order for the comments

confluence_label_attachments_get#Retrieve the attachments associated with a specific Confluence label. Returns a paginated list of attachments; use cursor-based pagination for labels with many attachments.4 params▾

Retrieve the attachments associated with a specific Confluence label. Returns a paginated list of attachments; use cursor-based pagination for labels with many attachments.

NameTypeRequiredDescription

idstringrequiredThe ID of the label for which attachments should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of attachments to return per page (default 25, max 250)

sortstringoptionalSort order for attachments (e.g. created-date, -created-date, modified-date, -modified-date)

confluence_label_blog_posts_get#Retrieve the blog posts associated with a specific Confluence label. Supports filtering by space IDs, body format selection, and cursor-based pagination for labels with many blog posts.6 params▾

Retrieve the blog posts associated with a specific Confluence label. Supports filtering by space IDs, body format selection, and cursor-based pagination for labels with many blog posts.

NameTypeRequiredDescription

idstringrequiredThe ID of the label for which blog posts should be returned

body_formatstringoptionalThe content format to return in the body field of each blog post (e.g. storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of blog posts to return per page (default 25, max 250)

sortstringoptionalSort order for blog posts (e.g. id, -id, created-date, -created-date, modified-date, -modified-date)

space_idstringoptionalFilter results by one or more space IDs, specified as a comma-separated list (max 100)

confluence_label_pages_get#Retrieve the pages associated with a specific Confluence label. Supports filtering by space IDs, body format selection, and cursor-based pagination for labels with many pages.6 params▾

Retrieve the pages associated with a specific Confluence label. Supports filtering by space IDs, body format selection, and cursor-based pagination for labels with many pages.

NameTypeRequiredDescription

idstringrequiredThe ID of the label for which pages should be returned

body_formatstringoptionalThe content format to return in the body field of each page (e.g. storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of pages to return per page (default 25, max 250)

sortstringoptionalSort order for pages (e.g. id, -id, created-date, -created-date, modified-date, -modified-date, title, -title)

space_idstringoptionalFilter results by one or more space IDs, specified as a comma-separated list (max 100)

confluence_labels_list#List all labels across the Confluence site. Supports filtering by label ID or prefix, and cursor-based pagination. Only labels that the user has permission to view are returned.5 params▾

List all labels across the Confluence site. Supports filtering by label ID or prefix, and cursor-based pagination. Only labels that the user has permission to view are returned.

NameTypeRequiredDescription

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

label_idstringoptionalFilter by one or more label IDs, specified as a comma-separated list

limitintegeroptionalMaximum number of labels to return per page (default 25, max 250)

prefixstringoptionalFilter by one or more label prefixes, specified as a comma-separated list

sortstringoptionalSort order for labels (e.g. created-date, -created-date, id, -id, name, -name)

confluence_page_ancestors_get#Retrieve all ancestors of a Confluence page in top-to-bottom order (the highest ancestor first). Returns minimal information about each ancestor; use the Get Page tool for full details.2 params▾

Retrieve all ancestors of a Confluence page in top-to-bottom order (the highest ancestor first). Returns minimal information about each ancestor; use the Get Page tool for full details.

NameTypeRequiredDescription

idstringrequiredThe ID of the page

limitintegeroptionalMaximum number of pages per result to return (default 25, max 250). If more results exist, call this endpoint with the highest ancestor's ID

confluence_page_attachments_get#Retrieve all attachments on a Confluence page. Returns a paginated list of attachments with metadata including filename, media type, file size, and download URL. Supports filtering by media type or filename and cursor-based pagination.6 params▾

Retrieve all attachments on a Confluence page. Returns a paginated list of attachments with metadata including filename, media type, file size, and download URL. Supports filtering by media type or filename and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the page whose attachments to retrieve

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

filenamestringoptionalFilter attachments by exact filename

limitintegeroptionalMaximum number of attachments to return per page (default 25, max 250)

media_typestringoptionalFilter attachments by MIME media type (e.g. image/png, application/pdf)

sortstringoptionalSort order for attachments (e.g. created-date, -created-date, modified-date, -modified-date)

confluence_page_children_get#Retrieve the direct child pages of a given Confluence page. Returns a paginated list of child pages with their IDs, titles, and statuses. Use cursor-based pagination to iterate through large result sets.4 params▾

Retrieve the direct child pages of a given Confluence page. Returns a paginated list of child pages with their IDs, titles, and statuses. Use cursor-based pagination to iterate through large result sets.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent page whose children to retrieve

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of child pages to return (default 25, max 250)

sortstringoptionalSort order for child pages (e.g. -modified-date, id, title, -title)

confluence_page_create#Create a new Confluence page in a specified space. Requires a space ID and title. Optionally set the initial status (current for published, draft for unpublished), a parent page, and body content. The body requires both body_representation and body_value to be provided together.8 params▾

Create a new Confluence page in a specified space. Requires a space ID and title. Optionally set the initial status (current for published, draft for unpublished), a parent page, and body content. The body requires both body_representation and body_value to be provided together.

NameTypeRequiredDescription

spaceIdstringrequiredThe ID of the space in which to create the page

titlestringrequiredTitle of the new page

body_representationstringoptionalThe markup format for the page body (e.g. storage, atlas_doc_format). Must be set together with body_value.

body_valuestringoptionalThe raw content of the page body in the format specified by body_representation. Must be set together with body_representation.

parentIdstringoptionalID of the parent page under which this page will be created

privatebooleanoptionalSet to true to create the page as a private page visible only to the creator

root_levelbooleanoptionalSet to true to create the page at the root level of the space (no parent)

statusstringoptionalInitial status of the page: current (published) or draft (unpublished)

confluence_page_custom_content_get#Retrieve all custom content of a given type within a specific Confluence page. The type parameter is required and identifies which kind of custom content to return. Supports body format selection and cursor-based pagination.6 params▾

Retrieve all custom content of a given type within a specific Confluence page. The type parameter is required and identifies which kind of custom content to return. Supports body format selection and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the page for which custom content should be returned

typestringrequiredThe type of custom content being requested (e.g. a registered app's custom content type identifier)

body_formatstringoptionalThe content format to return in the body field of each custom content item (e.g. raw, storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of custom content items to return per page (default 25, max 250)

sortstringoptionalSort order for custom content (e.g. id, -id, created-date, -created-date, modified-date, -modified-date, title, -title)

confluence_page_delete#Delete a Confluence page by its ID. By default moves the page to the trash; set purge=true to permanently delete without recovery. Set draft=true to delete a draft version instead of the published page. This action is irreversible when purge is enabled.3 params▾

Delete a Confluence page by its ID. By default moves the page to the trash; set purge=true to permanently delete without recovery. Set draft=true to delete a draft version instead of the published page. This action is irreversible when purge is enabled.

NameTypeRequiredDescription

idstringrequiredThe ID of the page to delete

draftbooleanoptionalSet to true to delete the draft version of the page rather than the published version

purgebooleanoptionalSet to true to permanently delete the page, bypassing the trash

confluence_page_descendants_get#Retrieve descendants of a Confluence page in the content tree, in top-to-bottom order (database, embed, folder, page, or whiteboard). Control how deep to traverse with the depth parameter, and paginate with cursor.4 params▾

Retrieve descendants of a Confluence page in the content tree, in top-to-bottom order (database, embed, folder, page, or whiteboard). Control how deep to traverse with the depth parameter, and paginate with cursor.

NameTypeRequiredDescription

idstringrequiredThe ID of the page

cursorstringoptionalCursor token for pagination, returned in the previous response as the cursor to fetch the next set of results

depthintegeroptionalMaximum depth of descendants to return (default 2, min 1, max 10)

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

confluence_page_direct_children_get#Retrieve the direct children of a Confluence page in the content tree (database, embed, folder, page, or whiteboard). Returns minimal information about each child; use a related get-by-id endpoint for full details. Results are paginated via cursor.4 params▾

Retrieve the direct children of a Confluence page in the content tree (database, embed, folder, page, or whiteboard). Returns minimal information about each child; use a related get-by-id endpoint for full details. Results are paginated via cursor.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent page

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. created-date, -created-date, id, -id, modified-date, -modified-date, child-position, -child-position, title, -title)

confluence_page_get#Retrieve a single Confluence page by its ID. Returns the page title, status, version, space, and optionally the full body content. Use body_format to control the markup format returned. Additional flags expose labels, properties, and version history.7 params▾

Retrieve a single Confluence page by its ID. Returns the page title, status, version, space, and optionally the full body content. Use body_format to control the markup format returned. Additional flags expose labels, properties, and version history.

NameTypeRequiredDescription

idstringrequiredThe ID of the page to retrieve

body_formatstringoptionalFormat for the returned page body (e.g. storage, atlas_doc_format, anonymous_export_view)

get_draftbooleanoptionalSet to true to retrieve the draft version of the page instead of the published version

include_labelsbooleanoptionalSet to true to include labels attached to the page in the response

include_propertiesbooleanoptionalSet to true to include content properties attached to the page

include_versionbooleanoptionalSet to true to include full version details in the response

versionintegeroptionalSpecific version number of the page to retrieve (defaults to latest)

confluence_page_inline_comments_get#Retrieve the root inline comments of a specific Confluence page. Returns paginated comment results including author, content, and status. Supports filtering by status and resolution status, sorting, and cursor-based pagination.7 params▾

Retrieve the root inline comments of a specific Confluence page. Returns paginated comment results including author, content, and status. Supports filtering by status and resolution status, sorting, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the page whose inline comments to retrieve

body_formatstringoptionalFormat of the comment body to include in the response

cursorstringoptionalCursor token for fetching the next page of results

limitintegeroptionalMaximum number of inline comments to return per page

resolution_statusarrayoptionalFilter inline comments by resolution status. Accepts an array of values: resolved, open, dangling, reopened.

sortstringoptionalSort order for the comments

statusarrayoptionalFilter inline comments by status. Accepts an array of values: current, archived, trashed, deleted, historical, draft.

confluence_page_labels_get#Retrieve all labels attached to a Confluence page. Labels can be filtered by prefix (e.g. global, my, team). Returns a paginated list of label names and prefixes. Use cursor-based pagination for pages with many labels.5 params▾

Retrieve all labels attached to a Confluence page. Labels can be filtered by prefix (e.g. global, my, team). Returns a paginated list of label names and prefixes. Use cursor-based pagination for pages with many labels.

NameTypeRequiredDescription

idstringrequiredThe ID of the page whose labels to retrieve

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of labels to return per page (default 25, max 250)

prefixstringoptionalFilter labels by prefix (e.g. global, my, team, system)

sortstringoptionalSort order for labels (e.g. created-date, -created-date, name, -name)

confluence_page_like_count_get#Retrieve the total count of likes on a specific Confluence page.1 param▾

Retrieve the total count of likes on a specific Confluence page.

NameTypeRequiredDescription

idstringrequiredThe ID of the page for which like count should be returned

confluence_page_likes_get#Retrieve the account IDs of users who liked a specific Confluence page. Returns a paginated list of account IDs. Use cursor-based pagination to iterate through large result sets.3 params▾

Retrieve the account IDs of users who liked a specific Confluence page. Returns a paginated list of account IDs. Use cursor-based pagination to iterate through large result sets.

NameTypeRequiredDescription

idstringrequiredThe ID of the page for which like count should be returned

cursorstringoptionalUsed for pagination, this opaque cursor will be returned in the next URL in the Link response header

limitintegeroptionalMaximum number of account IDs per result to return (default 25, max 250)

confluence_page_list#List Confluence pages with optional filtering by space, status, title, or page IDs. Returns a paginated collection of pages. Use the cursor parameter to fetch subsequent pages. Supports body format selection for inline content retrieval.8 params▾

List Confluence pages with optional filtering by space, status, title, or page IDs. Returns a paginated collection of pages. Use the cursor parameter to fetch subsequent pages. Supports body format selection for inline content retrieval.

NameTypeRequiredDescription

body_formatstringoptionalThe content format to return for page bodies (e.g. storage, atlas_doc_format, anonymous_export_view)

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

idstringoptionalFilter by one or more page IDs (comma-separated or repeated query param)

limitintegeroptionalMaximum number of pages to return per page (default 25, max 250)

sortstringoptionalSort order for results (e.g. -modified-date, id, title, -title)

space_idstringoptionalFilter by one or more space IDs (comma-separated)

statusstringoptionalFilter pages by status (e.g. current, archived, deleted, trashed)

titlestringoptionalFilter pages by title (exact match)

confluence_page_title_update#Update only the title of an existing Confluence page, without needing to supply the full page body or version number. Requires the page ID, the desired status (current or draft), and the new title.3 params▾

Update only the title of an existing Confluence page, without needing to supply the full page body or version number. Requires the page ID, the desired status (current or draft), and the new title.

NameTypeRequiredDescription

idstringrequiredThe ID of the page to be updated

statusstringrequiredThe status of the page: current or draft

titlestringrequiredThe updated title for the page

confluence_page_update#Update an existing Confluence page. Requires the page ID, current status, title, and the next version number (must be exactly current version + 1). Optionally update the page body, change the parent, or add a version message. Retrieve the current version number with the Get Page tool before calling this.8 params▾

Update an existing Confluence page. Requires the page ID, current status, title, and the next version number (must be exactly current version + 1). Optionally update the page body, change the parent, or add a version message. Retrieve the current version number with the Get Page tool before calling this.

NameTypeRequiredDescription

idstringrequiredThe ID of the page to update

statusstringrequiredStatus of the page after the update (e.g. current, draft)

titlestringrequiredUpdated title of the page

version_numberintegerrequiredThe new version number for this update. Must be exactly the current version number plus 1.

body_representationstringoptionalFormat for the updated body content (e.g. storage, atlas_doc_format). Must be set together with body_value.

body_valuestringoptionalThe updated body content in the format specified by body_representation. Must be set together with body_representation.

parentIdstringoptionalID of the new parent page (to move the page in the hierarchy)

version_messagestringoptionalOptional message describing what changed in this version

confluence_page_version_get#Retrieve version details for a specific version number of a Confluence page.2 params▾

Retrieve version details for a specific version number of a Confluence page.

NameTypeRequiredDescription

page_idstringrequiredThe ID of the page for which version details should be returned

version_numberstringrequiredThe version number of the page to be returned

confluence_page_versions_get#Retrieve the version history of a specific Confluence page. Returns a paginated list of versions with metadata such as version number, author, and creation date. Use body_format to include body content per version and sort to control ordering.5 params▾

Retrieve the version history of a specific Confluence page. Returns a paginated list of versions with metadata such as version number, author, and creation date. Use body_format to include body content per version and sort to control ordering.

NameTypeRequiredDescription

idstringrequiredThe ID of the page to be queried for its versions

body_formatstringoptionalThe content format types to be returned in the body field of the response (storage or atlas_doc_format)

cursorstringoptionalUsed for pagination, this opaque cursor will be returned in the next URL in the Link response header

limitintegeroptionalMaximum number of versions per result to return (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (modified-date or -modified-date)

confluence_search#Search Confluence content using Confluence Query Language (CQL). CQL is a powerful structured query language for finding pages, blog posts, spaces, attachments, and comments. Returns matching content with metadata including title, space, author, and last modified date.5 params▾

Search Confluence content using Confluence Query Language (CQL). CQL is a powerful structured query language for finding pages, blog posts, spaces, attachments, and comments. Returns matching content with metadata including title, space, author, and last modified date.

NameTypeRequiredDescription

cqlstringrequiredConfluence Query Language (CQL) query string

cursorstringoptionalCursor token for fetching the next page of results

excerptstringoptionalControls excerpt handling in search results

expandstringoptionalComma-separated list of properties to expand in results

limitintegeroptionalMaximum number of results to return

confluence_smart_link_ancestors_get#Retrieve all ancestors of a Confluence Smart Link (embed) in the content tree, in top-to-bottom order (the highest ancestor is first in the response). If more results exist, call again using the ID of the first ancestor returned.2 params▾

Retrieve all ancestors of a Confluence Smart Link (embed) in the content tree, in top-to-bottom order (the highest ancestor is first in the response). If more results exist, call again using the ID of the first ancestor returned.

NameTypeRequiredDescription

idstringrequiredThe ID of the Smart Link (embed) in the content tree

limitintegeroptionalMaximum number of items to return (default 25, max 250)

confluence_smart_link_descendants_get#Retrieve descendants in the content tree for a Confluence Smart Link (embed), in top-to-bottom order (the highest descendant is first in the response). Supports a depth parameter to limit how many levels of descendants are returned, and cursor-based pagination for additional results.4 params▾

Retrieve descendants in the content tree for a Confluence Smart Link (embed), in top-to-bottom order (the highest descendant is first in the response). Supports a depth parameter to limit how many levels of descendants are returned, and cursor-based pagination for additional results.

NameTypeRequiredDescription

idstringrequiredThe ID of the Smart Link (embed)

cursorstringoptionalOpaque cursor for pagination, returned in the Link response header of a previous call

depthintegeroptionalMaximum depth of descendants to return (default 2, max 10)

limitintegeroptionalMaximum number of items to return per result (default 25, max 250)

confluence_smart_link_direct_children_get#Retrieve the direct children of a Confluence Smart Link (embed) in the content tree (database, embed, folder, page, or whiteboard types). Returns minimal information about each child; use cursor-based pagination via the returned Link header to fetch more results.4 params▾

Retrieve the direct children of a Confluence Smart Link (embed) in the content tree (database, embed, folder, page, or whiteboard types). Returns minimal information about each child; use cursor-based pagination via the returned Link header to fetch more results.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent Smart Link (embed)

cursorstringoptionalOpaque cursor for pagination, returned in the Link response header of a previous call

limitintegeroptionalMaximum number of items to return per result (default 25, max 250)

sortstringoptionalField and direction to sort the results by. Valid values: created-date, -created-date, id, -id, modified-date, -modified-date, child-position, -child-position, title, -title

confluence_space_blogposts_list#Retrieve all blog posts in a specific Confluence space. Supports filtering by status and title, control of returned body format, and cursor-based pagination.7 params▾

Retrieve all blog posts in a specific Confluence space. Supports filtering by status and title, control of returned body format, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which blog posts should be returned

body_formatstringoptionalFormat of the blog post body to return (storage or atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of blog posts per result to return (default 25, max 250)

sortstringoptionalSort order for the results (id, -id, created-date, -created-date, modified-date, -modified-date)

statusarrayoptionalFilter results to blog posts based on their status (current, deleted, trashed). Defaults to current.

titlestringoptionalFilter results to blog posts based on their title

confluence_space_content_labels_get#Retrieve labels attached to content (pages, blog posts, etc.) within a Confluence space. Only labels the caller has permission to view are returned. Supports filtering by prefix, sorting, and cursor-based pagination.5 params▾

Retrieve labels attached to content (pages, blog posts, etc.) within a Confluence space. Only labels the caller has permission to view are returned. Supports filtering by prefix, sorting, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which content labels should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of labels to return per page (default 25, max 250)

prefixstringoptionalFilter the results to labels based on their prefix (e.g. my, team)

sortstringoptionalUsed to sort the result by a particular field (e.g. created-date, -created-date, id, -id, name, -name)

confluence_space_create#Create a new Confluence space. Requires a name; optionally set a unique space key, description (in plain or view format), and alias. Available on tenants with Role-Based Access Control.4 params▾

Create a new Confluence space. Requires a name; optionally set a unique space key, description (in plain or view format), and alias. Available on tenants with Role-Based Access Control.

NameTypeRequiredDescription

namestringrequiredThe display name of the new space

aliasstringoptionalAlternative alias for the space, used in some URL contexts

descriptionstringoptionalPlain text description of the space's purpose

keystringoptionalUnique short key that identifies the space (e.g. DEV, TEAM). Auto-generated from name if omitted.

confluence_space_custom_content_list#Returns all custom content of a given type within a specific Confluence space. Custom content is app-defined content stored under a container such as a space. Results are paginated via cursor; use the type parameter to filter to a specific custom content type.5 params▾

Returns all custom content of a given type within a specific Confluence space. Custom content is app-defined content stored under a container such as a space. Results are paginated via cursor; use the type parameter to filter to a specific custom content type.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which custom content should be returned

typestringrequiredThe type of custom content being requested

body_formatstringoptionalThe content format types to be returned in the body field of the response (e.g. raw, storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

limitintegeroptionalMaximum number of custom content items to return per page (default 25, max 250)

confluence_space_get#Retrieve details of a specific Confluence space by its ID. Returns space metadata including key, name, type, status, description, homepage, and permissions. Optionally include the space icon and labels.4 params▾

Retrieve details of a specific Confluence space by its ID. Returns space metadata including key, name, type, status, description, homepage, and permissions. Optionally include the space icon and labels.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the space to retrieve

description_formatstringoptionalFormat for the space description in the response

include_iconbooleanoptionalWhether to include the space icon in the response

include_labelsbooleanoptionalWhether to include labels applied to the space

confluence_space_labels_list#Retrieve the labels of a specific Confluence space. Only labels the user has permission to view are returned. Supports filtering by prefix and cursor-based pagination.5 params▾

Retrieve the labels of a specific Confluence space. Only labels the user has permission to view are returned. Supports filtering by prefix and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which labels should be returned

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of labels per result to return (default 25, max 250)

prefixstringoptionalFilter the results to labels based on their prefix (my or team)

sortstringoptionalSort order for labels (created-date, -created-date, id, -id, name, -name)

confluence_space_list#List Confluence spaces accessible to the authenticated user. Supports filtering by space IDs, keys, type (global or personal), status (current or archived), and labels. Returns paginated results with cursor-based navigation.9 params▾

List Confluence spaces accessible to the authenticated user. Supports filtering by space IDs, keys, type (global or personal), status (current or archived), and labels. Returns paginated results with cursor-based navigation.

NameTypeRequiredDescription

cursorstringoptionalCursor token for fetching the next page of results

description_formatstringoptionalFormat for the space description in the response

idsarrayoptionalFilter spaces by their numeric IDs

keysarrayoptionalFilter spaces by their space keys

labelsarrayoptionalFilter spaces by labels

limitintegeroptionalMaximum number of spaces to return per page

sortstringoptionalSort order for the results

statusstringoptionalFilter spaces by status

typestringoptionalFilter spaces by type

confluence_space_pages_list#Returns all pages in a Confluence space. Only pages the caller has permission to view are returned. Supports filtering by depth, status, and title, sorting, and cursor-based pagination.8 params▾

Returns all pages in a Confluence space. Only pages the caller has permission to view are returned. Supports filtering by depth, status, and title, sorting, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which pages should be returned

body_formatstringoptionalThe content format types to be returned in the body field of the response (e.g. storage, atlas_doc_format)

cursorstringoptionalCursor token for pagination, returned in previous response as _links.next

depthstringoptionalFilter the results to pages at the root level of the space or to all pages in the space (all, root)

limitintegeroptionalMaximum number of pages to return per page (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. id, -id, created-date, -created-date, modified-date, -modified-date, title, -title)

statusstringoptionalFilter pages by status, comma-separated (e.g. current, archived, deleted, trashed). Defaults to current and archived.

titlestringoptionalFilter the results to pages based on their title

confluence_space_role_assignments_list#Retrieve the space role assignments for a Confluence space. Only available on tenants with Role-Based Access Control enabled. Requires permission to view the space. Supports filtering by role, principal, and cursor-based pagination.7 params▾

Retrieve the space role assignments for a Confluence space. Only available on tenants with Role-Based Access Control enabled. Requires permission to view the space. Supports filtering by role, principal, and cursor-based pagination.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which to retrieve role assignments

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of space roles to return per page (default 25, max 250)

principal_idstringoptionalFilters the returned role assignments to the provided principal id. If specified, principal_type must also be specified. Paired with principal_type of ACCESS_CLASS, valid values include anonymous-users, jsm-project-admins, authenticated-users, all-licensed-users, all-product-admins

principal_typestringoptionalFilters the returned role assignments to the provided principal type (USER, GROUP, ACCESS_CLASS). If specified, principal_id must also be specified.

role_idstringoptionalFilters the returned role assignments to the provided role ID

role_typestringoptionalFilters the returned role assignments to the provided role type

confluence_space_role_assignments_set#Set role assignments for a Confluence space. For each principal provided with a roleId, that principal is assigned the role. For each principal provided without a roleId, the existing role assignment for that principal (if any) is removed. Available only on tenants with Role-Based Access Control enabled. Requires permission to manage roles in the space.2 params▾

Set role assignments for a Confluence space. For each principal provided with a roleId, that principal is assigned the role. For each principal provided without a roleId, the existing role assignment for that principal (if any) is removed. Available only on tenants with Role-Based Access Control enabled. Requires permission to manage roles in the space.

NameTypeRequiredDescription

idstringrequiredThe ID of the space for which to set role assignments

role_assignmentsarrayrequiredJSON array of role assignment objects. Each object has a principal (with id and type, e.g. 'user' or 'group') and an optional roleId. Omitting roleId removes the principal's existing role assignment.

confluence_space_role_create#Create a new space role for the tenant. Only available on tenants with Role-Based Access Control enabled. Requires organization or site admin permissions. Connect and Forge app users cannot access this resource.3 params▾

Create a new space role for the tenant. Only available on tenants with Role-Based Access Control enabled. Requires organization or site admin permissions. Connect and Forge app users cannot access this resource.

NameTypeRequiredDescription

descriptionstringrequiredDescription for the space role

namestringrequiredName of the space role

space_permissionsarrayrequiredThe ids of the space permissions associated with the space role, as a JSON array of strings. Sample value "read/space"; retrieve ids from the GET /space-permissions endpoint

confluence_space_role_delete#Delete a space role by its ID. Only available on tenants with Role-Based Access Control enabled. Requires organization or site admin permissions. This action is irreversible.1 param▾

Delete a space role by its ID. Only available on tenants with Role-Based Access Control enabled. Requires organization or site admin permissions. This action is irreversible.

NameTypeRequiredDescription

idstringrequiredId of the space role to delete

confluence_space_role_get#Retrieve a single space role by its ID. Only available on tenants with Role-Based Access Control enabled. Requires permission to access the Confluence site.1 param▾

Retrieve a single space role by its ID. Only available on tenants with Role-Based Access Control enabled. Requires permission to access the Confluence site.

NameTypeRequiredDescription

idstringrequiredThe ID of the space role to retrieve

confluence_space_role_mode_get#Retrieve the tenant's current space role mode. Only available on tenants with Role-Based Access Control enabled. Requires the 'Can use' global permission on the Confluence site.0 params▾

Retrieve the tenant's current space role mode. Only available on tenants with Role-Based Access Control enabled. Requires the 'Can use' global permission on the Confluence site.

confluence_space_role_update#Update an existing space role. Only available on tenants with Role-Based Access Control enabled. Requires organization or site admin permissions. Optionally reassign anonymous or guest role assignments to another role when they are removed from this role.6 params▾

Update an existing space role. Only available on tenants with Role-Based Access Control enabled. Requires organization or site admin permissions. Optionally reassign anonymous or guest role assignments to another role when they are removed from this role.

NameTypeRequiredDescription

descriptionstringrequiredDescription for the space role

idstringrequiredId of the space role to update

namestringrequiredName of the space role

space_permissionsarrayrequiredThe ids of the space permissions associated with the space role, as a JSON array of strings. Sample value "read/space"; retrieve ids from the GET /space-permissions endpoint

anonymous_reassignment_role_idstringoptionalIf space anonymous access is assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Anonymous access role assignments are left unchanged if unspecified.

guest_reassignment_role_idstringoptionalIf guests are assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Guest role assignments are left unchanged if unspecified.

confluence_space_roles_list#Retrieve the available space roles for the tenant, optionally filtered to a specific space. Only available on tenants with Role-Based Access Control enabled. Supports filtering by role type, principal, and cursor-based pagination.6 params▾

Retrieve the available space roles for the tenant, optionally filtered to a specific space. Only available on tenants with Role-Based Access Control enabled. Supports filtering by role type, principal, and cursor-based pagination.

NameTypeRequiredDescription

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

limitintegeroptionalMaximum number of space roles to return per page (default 25, max 250)

principal_idstringoptionalThe principal ID to filter results by. If specified, principal_type must also be specified. Paired with principal_type of ACCESS_CLASS, valid values include anonymous-users, jsm-project-admins, authenticated-users, all-licensed-users, all-product-admins

principal_typestringoptionalThe principal type to filter results by (USER, GROUP, ACCESS_CLASS). If specified, principal_id must also be specified.

role_typestringoptionalThe space role type to filter results by

space_idstringoptionalThe space ID for which to filter available space roles; if empty, returns all available space roles for the tenant

confluence_task_get#Retrieve a specific Confluence task by its ID. Returns the task text, status, and location within its containing page or blog post.2 params▾

Retrieve a specific Confluence task by its ID. Returns the task text, status, and location within its containing page or blog post.

NameTypeRequiredDescription

idstringrequiredThe ID of the task to be returned. If you don't know the task ID, use List Tasks and filter the results

body_formatstringoptionalThe content format types to be returned in the body field of the response (e.g. storage, atlas_doc_format)

confluence_task_list#List all Confluence tasks the current user has permission to view. Supports filtering by status, space, page, blog post, creator, assignee, completer, and various date ranges. Results are paginated via cursor.18 params▾

List all Confluence tasks the current user has permission to view. Supports filtering by status, space, page, blog post, creator, assignee, completer, and various date ranges. Results are paginated via cursor.

NameTypeRequiredDescription

assigned_tostringoptionalFilters on the Account ID of the user to whom this task is assigned (comma-separated string, up to 250 IDs)

blogpost_idstringoptionalFilters on the blog post ID of the task (comma-separated string, up to 250 IDs). Can be used together with page-id filters

body_formatstringoptionalThe content format types to be returned in the body field of the response (e.g. storage, atlas_doc_format)

completed_at_fromintegeroptionalFilters on start of date-time range of task based on completion date (inclusive). Epoch time in milliseconds

completed_at_tointegeroptionalFilters on end of date-time range of task based on completion date (inclusive). Epoch time in milliseconds

completed_bystringoptionalFilters on the Account ID of the user who completed this task (comma-separated string, up to 250 IDs)

created_at_fromintegeroptionalFilters on start of date-time range of task based on creation date (inclusive). Epoch time in milliseconds

created_at_tointegeroptionalFilters on end of date-time range of task based on creation date (inclusive). Epoch time in milliseconds

created_bystringoptionalFilters on the Account ID of the user who created this task (comma-separated string, up to 250 IDs)

cursorstringoptionalCursor token for pagination, returned in the previous response as _links.next

due_at_fromintegeroptionalFilters on start of date-time range of task based on due date (inclusive). Epoch time in milliseconds

due_at_tointegeroptionalFilters on end of date-time range of task based on due date (inclusive). Epoch time in milliseconds

include_blank_tasksbooleanoptionalSpecifies whether to include blank tasks in the response. Defaults to true

limitintegeroptionalMaximum number of tasks to return per page (default 25, max 250)

page_idstringoptionalFilters on the page ID of the task (comma-separated string, up to 250 IDs). Can be used together with blogpost-id filters

space_idstringoptionalFilters on the space ID of the task (comma-separated string, up to 250 IDs)

statusstringoptionalFilters on the status of the task (complete or incomplete)

task_idstringoptionalFilters on task ID (comma-separated string, up to 250 IDs)

confluence_task_update#Update a Confluence task by ID. This endpoint currently only supports updating the task status (complete or incomplete). Requires the current version number of the containing content plus 1.4 params▾

Update a Confluence task by ID. This endpoint currently only supports updating the task status (complete or incomplete). Requires the current version number of the containing content plus 1.

NameTypeRequiredDescription

idstringrequiredThe ID of the task to be updated. If you don't know the task ID, use List Tasks and filter the results

statusstringrequiredThe new status of the task (complete or incomplete)

version_numberintegerrequiredThe new version number for this update. Must be exactly the current version number of the task plus 1

body_formatstringoptionalThe content format types to be returned in the body field of the response (e.g. storage, atlas_doc_format)

confluence_users_bulk_lookup#Look up user details in bulk for a list of account IDs. Returns user details for each ID provided that the requester has permission to view. Requires permission to access the Confluence site and to view user profiles.1 param▾

Look up user details in bulk for a list of account IDs. Returns user details for each ID provided that the requester has permission to view. Requires permission to access the Confluence site and to view user profiles.

NameTypeRequiredDescription

idsarrayrequiredJSON array of account IDs to look up user details for

confluence_whiteboard_ancestors_get#Retrieve all ancestors of a given Confluence whiteboard in top-to-bottom order (the highest ancestor is first in the response). Returns minimal information about each ancestor; use a type-specific tool such as Get Whiteboard to fetch more details.2 params▾

Retrieve all ancestors of a given Confluence whiteboard in top-to-bottom order (the highest ancestor is first in the response). Returns minimal information about each ancestor; use a type-specific tool such as Get Whiteboard to fetch more details.

NameTypeRequiredDescription

idstringrequiredThe ID of the whiteboard

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

confluence_whiteboard_children_get#Retrieve the direct children of a given Confluence whiteboard in the content tree (database, embed, folder, page, or whiteboard). Returns minimal information about each child; use a type-specific tool to fetch more details.4 params▾

Retrieve the direct children of a given Confluence whiteboard in the content tree (database, embed, folder, page, or whiteboard). Returns minimal information about each child; use a type-specific tool to fetch more details.

NameTypeRequiredDescription

idstringrequiredThe ID of the parent whiteboard

cursorstringoptionalUsed for pagination, this opaque cursor will be returned in the next URL in the Link response header

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

sortstringoptionalUsed to sort the result by a particular field (e.g. created-date, id, modified-date, child-position, title, and their descending variants)

confluence_whiteboard_create#Create a new whiteboard in a specified Confluence space. Requires a space ID. Optionally set a title, a parent content ID, a template to pre-populate the whiteboard, and a locale for the template. Set private=true to restrict visibility to the creator.6 params▾

Create a new whiteboard in a specified Confluence space. Requires a space ID. Optionally set a title, a parent content ID, a template to pre-populate the whiteboard, and a locale for the template. Set private=true to restrict visibility to the creator.

NameTypeRequiredDescription

space_idstringrequiredThe ID of the space in which to create the whiteboard

localestringoptionalIf template_key is provided, locale determines the language the template is created with

parent_idstringoptionalThe parent content ID of the whiteboard

privatebooleanoptionalSet to true to create the whiteboard as private, visible only to the creator

template_keystringoptionalProviding a template key will add that template to the new whiteboard (e.g. kanban-board, sprint-planning, swot-analysis)

titlestringoptionalTitle of the whiteboard

confluence_whiteboard_delete#Delete a Confluence whiteboard by its ID. Moves the whiteboard to the trash, where it can be restored later.1 param▾

Delete a Confluence whiteboard by its ID. Moves the whiteboard to the trash, where it can be restored later.

NameTypeRequiredDescription

idstringrequiredThe ID of the whiteboard to be deleted

confluence_whiteboard_descendants_get#Retrieve descendants of a given Confluence whiteboard in top-to-bottom order (database, embed, folder, page, or whiteboard). Use depth to control how many levels deep to fetch, and cursor for pagination through additional results.4 params▾

Retrieve descendants of a given Confluence whiteboard in top-to-bottom order (database, embed, folder, page, or whiteboard). Use depth to control how many levels deep to fetch, and cursor for pagination through additional results.

NameTypeRequiredDescription

idstringrequiredThe ID of the whiteboard

cursorstringoptionalUsed for pagination, this opaque cursor will be returned in the response payload for fetching the next set of results

depthintegeroptionalMaximum depth of descendants to return (default 2, max 10)

limitintegeroptionalMaximum number of items per result to return (default 25, max 250)

confluence_whiteboard_get#Retrieve a single Confluence whiteboard by its ID. Returns the whiteboard title, space, and status. Optional flags expose collaborators, direct children, operations, and content properties.5 params▾

Retrieve a single Confluence whiteboard by its ID. Returns the whiteboard title, space, and status. Optional flags expose collaborators, direct children, operations, and content properties.

NameTypeRequiredDescription

idstringrequiredThe ID of the whiteboard to be returned

include_collaboratorsbooleanoptionalSet to true to include collaborators on the whiteboard

include_direct_childrenbooleanoptionalSet to true to include direct children of the whiteboard

include_operationsbooleanoptionalSet to true to include operations associated with this whiteboard (limited to 50 results)

include_propertiesbooleanoptionalSet to true to include content properties associated with this whiteboard (limited to 50 results)