Confluence

Overview

Confluence is Atlassian’s collaboration and knowledge management platform, used by teams to create, organize, and share documentation, wikis, and project plans in a single space. With the Confluence integration in SquadOS, your agents can create and update pages, publish blog posts, search content with CQL, manage tasks, and monitor changes in real time — all programmatically.

• Official website: https://www.atlassian.com/software/confluence
• Composio documentation: docs.composio.dev/toolkits/confluence

Authentication

This tool uses OAuth 2.0 (OAUTH2) to connect. S2S_OAUTH2 (server-to-server OAuth 2.0) and API_KEY are also supported.

You will need to authorize access to your Atlassian account through the Composio secure connection page. To set up custom OAuth credentials, see the Composio guide.

How to get credentials

For OAuth 2.0 (default), no manual credential is needed — access is authorized via the OAuth flow on the Composio page.

For API Key, follow these steps:

1. Go to id.atlassian.com/manage-profile/security/api-tokens and log in to your Atlassian account.
2. Click Create API token.
3. Give the token a descriptive name (e.g., “SquadOS”) and click Create.
4. Copy the generated token — it will not be shown again.

Tip

Use a dedicated API token for SquadOS. You can revoke tokens individually from the same screen without affecting other integrations.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Confluence.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you authorize access to your Atlassian account (OAuth 2.0).
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)

FAQ

How do I set up custom OAuth credentials for Confluence?

For a step-by-step guide on creating and configuring your own Confluence OAuth credentials with Composio, see How to create OAuth credentials for Confluence.

Available actions

Add Content Label

CONFLUENCE_ADD_CONTENT_LABEL

Tool to add labels to a piece of content. Use after obtaining the content ID to tag pages or blog posts with metadata labels.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence content (page or blog post) to label.
labels	array	Yes	List of labels to add to the content. Each element must be an object with prefix (one of global, team, or my) and name (lowercase alphanumeric/hyphenated string) fields. Passing plain strings or omitting prefix causes schema validation errors.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

CQL Search

CONFLUENCE_CQL_SEARCH

Searches for content in Confluence using Confluence Query Language (CQL). CQL is a powerful query language that allows you to search across all Confluence content with advanced filtering capabilities including full-text search (text ~ "search term"), title search (title ~ "meeting notes"), label filtering (label = "important"), space filtering (space = DEV), type filtering (type = page or type = blogpost), creator filtering (creator = currentUser()), date filtering (lastModified > now("-7d")), and combined queries (text ~ "api" AND space = DOCS AND type = page). This action uses the Confluence REST API v1 search endpoint which fully supports CQL.

Input parameters

Name	Type	Required	Description
cql	string	Yes	Confluence Query Language (CQL) query for searching content. Examples: text ~ "search term" (full-text search), label = "important" (search by label), type = page AND space = DEV (pages in DEV space), creator = currentUser() (content by current user).
limit	integer	No	Maximum number of results to return (max 250, but may be limited to 25–50 when using body expansions).
start	integer	No	Starting index for pagination (0-based).
expand	string	No	Comma-separated list of properties to expand in the response. Common values: content.space, content.version, content.body.storage.
excerpt	string	No	The type of excerpt to return. Default is highlight. Accepted values: highlight, indexed, none.
includeArchivedSpaces	boolean	No	Whether to include results from archived spaces.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Blogpost

CONFLUENCE_CREATE_BLOGPOST

Tool to create a new Confluence blog post. Use when you need to publish content in a specific space. Response includes data.id for the post ID and data._links.base + data._links.webui for the URL.

Input parameters

Name	Type	Required	Description
body	object	Yes	Content body of the blog post. Must be a dict with representation set to storage and value containing valid Confluence storage format markup (XML-based). Raw markdown or plain strings will cause validation errors.
title	string	Yes	The title of the new blog post.
status	string	Yes	Status of the blog post. Use current to publish immediately or draft to save as private draft.
spaceId	string	Yes	ID of the space where the blog post will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Blogpost Property

CONFLUENCE_CREATE_BLOGPOST_PROPERTY

Tool to create a property on a specified blog post. Use when you need to add custom metadata to a blog post. Creates a new key-value property on a specified Confluence blog post.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence blog post to add the property to.
key	string	Yes	Unique key for the blog post property.
value	string	Yes	JSON string representing the value of the blog post property.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Whiteboard Property

CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_WHITEBOARD

Tool to create a new content property on a whiteboard. Use when you need to attach custom metadata to a Confluence whiteboard.

Input parameters

Name	Type	Required	Description
key	string	Yes	Key/name of the property to create.
value	string	Yes	JSON string representing the value of the content property.
whiteboard_id	string	Yes	ID of the whiteboard to add the property to.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Footer Comment

CONFLUENCE_CREATE_FOOTER_COMMENT

Tool to create a footer comment on a Confluence page, blog post, attachment, or custom content. Use when you need to add a comment without editing the page body itself.

Input parameters

Name	Type	Required	Description
body	object	Yes	The body content of the comment with representation format and value.
pageId	string	No	ID of the page to comment on. Provide one of: pageId, blogPostId, attachmentId, or customContentId.
blogPostId	string	No	ID of the blog post to comment on. Provide one of: pageId, blogPostId, attachmentId, or customContentId.
attachmentId	string	No	ID of the attachment to comment on. Provide one of: pageId, blogPostId, attachmentId, or customContentId.
customContentId	string	No	ID of the custom content to comment on. Provide one of: pageId, blogPostId, attachmentId, or customContentId.
parentCommentId	string	No	ID of the parent comment. Provide this to create a reply to an existing comment.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Inline Comment

CONFLUENCE_CREATE_INLINE_COMMENT

Creates an inline comment on a Confluence page or blog post, highlighting specific text. For top-level comments, you must specify which text to highlight using inlineCommentProperties. For replies to existing inline comments, only provide the parentCommentId.

Input parameters

Name	Type	Required	Description
body	object	Yes	The body content of the comment with representation format and value.
pageId	string	No	ID of the page to create an inline comment on. Provide one of: pageId, blogPostId, or parentCommentId.
blogPostId	string	No	ID of the blog post to create an inline comment on. Provide one of: pageId, blogPostId, or parentCommentId.
parentCommentId	string	No	ID of the parent comment to reply to. Provide this to create a reply to an existing inline comment.
inlineCommentProperties	object	No	Properties that determine which text the inline comment is attached to. Required for top-level inline comments (not replies).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Page

CONFLUENCE_CREATE_PAGE

Tool to create a new Confluence page in a specified space. Use when you need to create new documentation or content.

Input parameters

Name	Type	Required	Description
body	object	No	Wrapper for page body content.
title	string	Yes	Title of the new page. Title uniqueness is scoped per parent: duplicates are allowed under different parents but not under the same parent.
spaceId	string	Yes	ID or key of the space where the page will be created. Can be a numeric space ID (e.g., 12345678) or a space key (e.g., DOCS, TEAM). Space keys are automatically converted to IDs.
parentId	string	No	ID of the parent page. If omitted, the Confluence API will automatically place the page under the space’s homepage. Must be a numeric page ID only.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Page Property

CONFLUENCE_CREATE_PAGE_PROPERTY

Tool to create a property on a Confluence page. Use when you need to add custom metadata or settings to a page.

Input parameters

Name	Type	Required	Description
key	string	Yes	Key/name of the property to create.
value	string	Yes	Value of the property as a JSON string. Can represent any JSON type (string, number, object, array).
page_id	string	Yes	ID of the page to create a property for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Private Space

CONFLUENCE_CREATE_PRIVATE_SPACE

Tool to create a private Confluence space. Use when you need an isolated workspace viewable only by its creator.

Input parameters

Name	Type	Required	Description
key	string	Yes	A unique key for the private space; must be unique and at most 255 characters. Must be alphanumeric only (no hyphens, underscores, or spaces).
name	string	Yes	The name of the private space, visible only to its creator.
description	object	No	Container for the plain-text description.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Space

CONFLUENCE_CREATE_SPACE

Tool to create a new Confluence space. Use when setting up a new knowledge area for organization. Must include a plain.representation field, e.g., {"plain": {"representation": "plain", "value": "text here"}}. Omitting this field causes a 400 error.

Input parameters

Name	Type	Required	Description
key	string	Yes	A unique key for the space. Must be alphanumeric characters only (letters and numbers), up to 255 characters. Underscores and hyphens are not allowed.
name	string	Yes	Human-readable name for the space.
type	string	No	Type of the space: global or personal.
metadata	string	No	Optional metadata for the space as a JSON string.
description	object	No	Description object for a Confluence space.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Space Property

CONFLUENCE_CREATE_SPACE_PROPERTY

Tool to create a new property on a Confluence space. Use after confirming the space ID when adding custom metadata.

Input parameters

Name	Type	Required	Description
key	string	Yes	Unique key for the space property.
value	string	Yes	JSON string representing the value of the space property.
spaceId	string	Yes	ID of the space to add the property to.
version	object	No	Optional version metadata for the new property.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Whiteboard

CONFLUENCE_CREATE_WHITEBOARD

Tool to create a new Confluence whiteboard. Use when you need to start a collaborative whiteboard session.

Input parameters

Name	Type	Required	Description
title	string	No	Title of the whiteboard.
spaceId	string	Yes	ID of the space where the whiteboard will be created.
parentId	string	No	ID of the parent content under which the whiteboard will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Blogpost Property

CONFLUENCE_DELETE_BLOGPOST_PROPERTY

Tool to delete a blog post property. Use when you need to remove custom metadata from a specified blog post.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the Confluence blog post containing the property.
propertyId	string	Yes	The ID of the blog post property to delete. Can be a numeric ID or a property key string.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Page Content Property

CONFLUENCE_DELETE_CONTENT_PROPERTY_FOR_PAGE_BY_ID

Tool to delete a content property from a page by property ID. Use when you need to remove custom metadata from a page for cleanup or auditing.

Input parameters

Name	Type	Required	Description
pageId	string	Yes	ID of the Confluence page from which to delete the property.
propertyId	string	Yes	The ID of the content property to delete from the page. Can be a numeric ID or a property key string.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Whiteboard Content Property

CONFLUENCE_DELETE_CONTENT_PROPERTY_FOR_WHITEBOARD_BY_ID

Tool to delete a content property from a whiteboard by property ID. Use when you need to remove custom metadata from a whiteboard.

Input parameters

Name	Type	Required	Description
propertyId	string	Yes	The ID of the property to delete from the whiteboard. Can be a numeric ID or a property key string.
whiteboardId	string	Yes	ID of the whiteboard from which to delete the property.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Page

CONFLUENCE_DELETE_PAGE

Tool to delete a Confluence page. Use with caution as this permanently removes the page and its content with no recovery option. In move or migration workflows, confirm all target pages were successfully created before deleting source pages — partial creation failures combined with deletion result in unrecoverable data loss.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the page to delete.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Space

CONFLUENCE_DELETE_SPACE

Tool to delete a Confluence space by its key. Use when you need to permanently remove a space.

Input parameters

Name	Type	Required	Description
space_key	string	Yes	Key of the space to delete.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Space Property

CONFLUENCE_DELETE_SPACE_PROPERTY

Tool to delete a space property. Use when you need to remove a property from a Confluence space after review.

Input parameters

Name	Type	Required	Description
propertyId	string	Yes	The ID of the space property to delete. Can be a numeric ID or a property key string.
spaceIdOrKey	integer	Yes	The numeric Long ID of the space containing the property. Must be a numeric space ID, not a space key or UUID.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Download Attachment

CONFLUENCE_DOWNLOAD_ATTACHMENT

Downloads an attachment from a Confluence page and returns a publicly accessible S3 URL. Use this when you need to share the attachment with users who don’t have Confluence access. First use CONFLUENCE_GET_ATTACHMENTS to list attachments and get the attachment ID.

Input parameters

Name	Type	Required	Description
pageId	string	Yes	ID of the Confluence page that contains the attachment.
attachmentId	string	Yes	ID of the attachment to download (e.g., att65825).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Attachment Labels

CONFLUENCE_GET_ATTACHMENT_LABELS

Tool to list labels on an attachment. Use after confirming the attachment ID to fetch its labels.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence attachment to retrieve labels for.
sort	string	No	Sort the result by a particular field.
limit	integer	No	Maximum number of labels to return per page (1–250).
cursor	string	No	Opaque cursor for pagination. Returned in the Link response header for fetching the next page.
prefix	string	No	Filter labels by their prefix. Values: my, team, global, system.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Attachments

CONFLUENCE_GET_ATTACHMENTS

Tool to retrieve attachments of a Confluence page. Use after confirming page ID to list its attachments (supports pagination).

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of attachments to return per page. Confluence caps at 200.
start	integer	No	Zero-based index of the first item to return (pagination offset).
pageId	string	Yes	ID of the Confluence page whose attachments will be retrieved.
mediaType	string	No	Filter attachments by MIME type (e.g., image/png, application/pdf).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Audit Logs

CONFLUENCE_GET_AUDIT_LOGS

Tool to retrieve Confluence audit records. Use when you need to fetch and filter audit logs for compliance or troubleshooting.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of audit records to return per page.
start	integer	No	Zero-based index of the first audit record to return (pagination offset).
endDate	integer	No	End of the audit record timestamp range (epoch time in milliseconds).
startDate	integer	No	Start of the audit record timestamp range (epoch time in milliseconds).
searchString	string	No	Free-text search to filter audit records by summary or category.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blogpost by ID

CONFLUENCE_GET_BLOGPOST_BY_ID

Tool to retrieve a specific Confluence blog post by its ID. Use when you have a blog post ID and need detailed metadata and content.

Input parameters

Name	Type	Required	Description
id	string	Yes	Unique identifier of the Confluence blog post to retrieve.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blogpost Labels

CONFLUENCE_GET_BLOGPOST_LABELS

Tool to retrieve labels of a specific Confluence blog post by ID. Use after obtaining the blog post ID to list its labels.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence blog post to retrieve labels for.
limit	integer	No	Maximum number of labels to return per page.
start	integer	No	Zero-based index of the first label to return (pagination offset).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blogpost Like Count

CONFLUENCE_GET_BLOGPOST_LIKE_COUNT

Tool to get like count for a Confluence blog post. Use after confirming the blog post ID to retrieve total likes.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence blog post to retrieve like count for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blogpost Operations

CONFLUENCE_GET_BLOGPOST_OPERATIONS

Tool to retrieve permitted operations for a Confluence blog post. Use after confirming the blog post ID to see allowed actions.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence blog post to query operations for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blog Posts

CONFLUENCE_GET_BLOG_POSTS

Tool to retrieve a list of blog posts. Use when you need a paginated list of Confluence blog posts.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of items to return per page.
cursor	string	No	Opaque pagination cursor for fetching the next page of results.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blog Posts For Label

CONFLUENCE_GET_BLOG_POSTS_FOR_LABEL

Tool to list all blog posts under a specific label. Use when you have a label ID and need to retrieve associated blog posts.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the label to retrieve blog posts for.
limit	integer	No	Maximum number of items to return per page.
cursor	string	No	Opaque pagination cursor for fetching the next page of results.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blogpost Version Details

CONFLUENCE_GET_BLOGPOST_VERSION_DETAILS

Tool to retrieve details for a specific version of a blog post. Use when you have a blogpostId and versionNumber and need detailed metadata for that version.

Input parameters

Name	Type	Required	Description
blogpostId	string	Yes	Unique identifier of the Confluence blog post.
versionNumber	integer	Yes	Version number of the blog post to retrieve.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blogpost Versions

CONFLUENCE_GET_BLOGPOST_VERSIONS

Tool to retrieve all versions of a specific blog post. Use when you have a blogpostId and need to list version numbers.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of version items to return per page.
cursor	string	No	Cursor for pagination. Use value from previous response to fetch next page.
blogpostId	string	Yes	The unique identifier of the Confluence blog post.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Child Pages

CONFLUENCE_GET_CHILD_PAGES

Tool to list all direct child pages of a given Confluence page. Use when you have a parent page ID and need to discover its direct descendants. Response nests child page data under data.data.results; unwrap this before iterating. Paginate using _links.next cursor until no further results to avoid missing children.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the Confluence page to retrieve child pages for. Returned child page IDs may be non-numeric strings; do not assume integer format when storing or passing to subsequent calls.
sort	string	No	Sort order options for child pages: id, -id, created-date, -created-date, modified-date, -modified-date, child-position, -child-position.
limit	integer	No	Maximum number of items to return per page. Maximum cap is 100. Paginate until _links.next is absent to ensure all children are retrieved.
cursor	string	No	Cursor for pagination. Use the cursor from the previous response’s _links.next to get the next page of results.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Blog Post Content Properties

CONFLUENCE_GET_CONTENT_PROPERTIES_FOR_BLOG_POST

Tool to retrieve all content properties on a blog post. Use when you need to list metadata properties set on a specific Confluence blog post.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of properties to return per page.
start	integer	No	Zero-based index of the first property to return (pagination offset).
blogpost_id	string	Yes	Identifier of the Confluence blog post to retrieve properties for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Content Properties

CONFLUENCE_GET_CONTENT_PROPERTIES_FOR_PAGE

Tool to retrieve all content properties on a page. Use when you need to list metadata properties set on a specific Confluence page.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of properties to return per page (max 200).
cursor	string	No	Opaque pagination cursor for fetching the next page of results.
page_id	string	Yes	Identifier of the Confluence page to retrieve properties for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Content Restrictions

CONFLUENCE_GET_CONTENT_RESTRICTIONS

Tool to retrieve restrictions on a Confluence content item. Use when you need to see who can view or edit a page or blog post.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the content to retrieve restrictions for.
expand	array	No	Comma-separated properties to expand in the response, e.g., restrictables.operation, user.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Current User

CONFLUENCE_GET_CURRENT_USER

Tool to get information about the currently authenticated user — always scoped to the account tied to the configured connection, not arbitrary users. Use CONFLUENCE_SEARCH_USERS to look up other users. Response contains nested metadata; key fields include accountId, displayName, and email.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Inline Comments for Blog Post

CONFLUENCE_GET_INLINE_COMMENTS_FOR_BLOG_POST

Tool to retrieve inline comments for a Confluence blog post. Use when you need inline comment details by blog post ID.

Input parameters

Name	Type	Required	Description
id	string	Yes	Unique identifier of the blog post to retrieve inline comments for.
sort	string	No	Sort order for results. Use - prefix for descending order. Values: created-date, -created-date, modified-date, -modified-date.
limit	integer	No	Maximum number of inline comments to return per page (default 25, max 250).
cursor	string	No	Cursor for pagination. Use the cursor from _links.next in the previous response.
body_format	string	No	The content format type for the comment body. Valid values: storage, atlas_doc_format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Labels

CONFLUENCE_GET_LABELS

Tool to retrieve all labels in a Confluence site; use for label discovery when you need to list or page through labels. For label-based filtering, use CONFLUENCE_GET_LABELS_FOR_PAGE or CONFLUENCE_GET_LABELS_FOR_SPACE_CONTENT instead.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of labels to return per page.
start	integer	No	Zero-based index of the first label to return (pagination offset).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Labels

CONFLUENCE_GET_LABELS_FOR_PAGE

Tool to retrieve labels of a specific Confluence page by ID. Labels are returned in data.results[*].name and are not available in CONFLUENCE_GET_PAGES responses. Use after obtaining the page ID to list its labels. Paginate using start and limit to avoid missing labels when count exceeds 25.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence page to retrieve labels for.
limit	integer	No	Maximum number of labels to return per page.
start	integer	No	Zero-based index of the first label to return (pagination offset). Increment by limit value iteratively to paginate through all labels.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Labels for Space

CONFLUENCE_GET_LABELS_FOR_SPACE

Tool to list labels on a space. Use when you need to retrieve labels for a specific space.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the space to retrieve labels for (numeric space ID).
sort	string	No	Sort order for results. Use - prefix for descending order. Values: created-date, -created-date, id, -id, name, -name.
limit	integer	No	Maximum number of labels to return per page (default 25, max 250).
cursor	string	No	Cursor for pagination. Use the cursor from the previous response to get the next page.
prefix	string	No	Filter labels by prefix. Values: my, team, global, system.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Labels for Space Content

CONFLUENCE_GET_LABELS_FOR_SPACE_CONTENT

Tool to list labels on all content in a space. Use when you need to retrieve or filter content labels by space, with pagination and optional prefix filtering. For label discovery across a space before per-page filtering, use this tool first, then CONFLUENCE_GET_LABELS_FOR_PAGE; CONFLUENCE_SEARCH_CONTENT does not filter by labels.

Input parameters

Name	Type	Required	Description
id	string	Yes	The ID of the space to list content labels for.
limit	integer	No	Maximum number of labels to return per page.
start	integer	No	Zero-based index of the first label to return (pagination offset).
prefix	string	No	Filter labels by this prefix (e.g., global, page-).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Ancestors

CONFLUENCE_GET_PAGE_ANCESTORS

Tool to retrieve all ancestors for a given Confluence page by its ID. Use when you need the full page hierarchy.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the Confluence page to retrieve ancestors for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page by ID

CONFLUENCE_GET_PAGE_BY_ID

Tool to retrieve a Confluence page by its ID. Use when you have a page ID and need its detailed metadata and content. Response body is in body.storage.value as Confluence storage format (HTML); strip tags before plain-text use. Before calling CONFLUENCE_UPDATE_PAGE, fetch the latest version here — that tool requires version.number = current + 1, else a 409 conflict occurs.

Input parameters

Name	Type	Required	Description
id	string	Yes	Numeric Long ID of the Confluence page to retrieve. Must be a numeric long value, not a UUID or string identifier.
draft	boolean	No	Whether to return the draft version (default: false).
version	integer	No	Specific page version to retrieve (default: latest).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Footer Comments

CONFLUENCE_GET_PAGE_FOOTER_COMMENTS

Tool to retrieve footer (non-inline) comments for a Confluence page. Use when you need to collect review feedback left as standard page comments.

Input parameters

Name	Type	Required	Description
id	string	Yes	Unique identifier of the page to retrieve footer comments for.
sort	string	No	Sort order for results. Use - prefix for descending order. Values: created-date, -created-date, modified-date, -modified-date.
limit	integer	No	Maximum number of footer comments to return per page (default 50, max 250).
cursor	string	No	Cursor for pagination. Use the cursor from _links.next in the previous response.
status	array	No	Filter comments by status. Can include multiple statuses.
body_format	string	No	The content format type for the comment body. Valid values: storage, atlas_doc_format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Inline Comments

CONFLUENCE_GET_PAGE_INLINE_COMMENTS

Tool to retrieve inline comments for a Confluence page. Use when you need inline comment details by page ID.

Input parameters

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the page to retrieve inline comments for.
sort	string	No	Sort order for results. Use - prefix for descending order. Values: created-date, -created-date, modified-date, -modified-date.
limit	integer	No	Maximum number of inline comments to return per page (default 25, max 250).
cursor	string	No	Cursor for pagination. Use the cursor from _links.next in the previous response.
status	array	No	Filter comments by status. Pass an array of status values.
body_format	string	No	The content format type for the comment body. Valid values: storage, atlas_doc_format.
resolution_status	array	No	Filter comments by resolution status. Pass an array of resolution status values (e.g., open, resolved).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Like Count

CONFLUENCE_GET_PAGE_LIKE_COUNT

Tool to get like count for a Confluence page. Use after confirming the page ID to retrieve total likes.

Input parameters

Name	Type	Required	Description
id	string	Yes	Identifier of the Confluence page to retrieve like count for.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Pages

CONFLUENCE_GET_PAGES

Tool to retrieve a paginated list of Confluence pages. Results are permission-scoped to the authenticated user; empty results may reflect access restrictions. Omitting filters like spaceId or status can return unexpectedly broad result sets. Labels are not included in results; use CONFLUENCE_GET_LABELS_FOR_PAGE for label data. Timestamps are ISO 8601 UTC strings.

Input parameters

Name	Type	Required	Description
sort	string	No	Sort order for pages. Values: id, -id, created-date, -created-date, modified-date, -modified-date, title, -title.
limit	integer	No	Maximum number of pages to return per page. Confluence caps at 250.
title	string	No	Filter by page title (exact match).
cursor	string	No	Opaque pagination cursor. Use the next link from a previous response to continue. Iterate until no next link is returned to avoid silently missing pages.
status	string	No	Filter by page status. Allowed values: current, archived, deleted, trashed.
subtype	string	No	Filter by page subtype. Valid values: live, page.
space_id	string	No	Filter by space ID(s). Provide a single ID or a list of IDs.
body_format	string	No	Body representation to include in results. Allowed values: storage or atlas_doc_format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Page Versions

CONFLUENCE_GET_PAGE_VERSIONS

Tool to retrieve all versions of a specific Confluence page. Use to audit edit history or to get the latest version.number before calling CONFLUENCE_UPDATE_PAGE — using a stale version.number causes a 409 Conflict error.

Input parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier of the Confluence page. String format; differs from the numeric long expected by CONFLUENCE_GET_PAGE_BY_ID.
limit	integer	No	Maximum number of versions to return per page. Older versions are silently omitted if pagination is not followed.
start	integer	No	Zero-based index of the first version to return (pagination offset).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Space by ID

CONFLUENCE_GET_SPACE_BY_ID

Tool to retrieve a Confluence space by its ID. Use when you need detailed metadata of a specific space. Space names are non-unique; use the numeric spaceId or spaceKey from the response for stable identification in downstream operations.

Input parameters

Name	Type	Required	Description
id	string	Yes	The numeric space ID (e.g., 557060). This is NOT the space key (e.g., GTS). Use CONFLUENCE_GET_SPACES to find a space’s numeric ID from its key.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Space Contents

CONFLUENCE_GET_SPACE_CONTENTS

Tool to retrieve content in a Confluence space. Use when you need to list pages, blogposts, or attachments of a specific space key. Results are in data.results (not data.page.results). Paginate via start/limit (max 200/request); follow response._links.next until absent. Atlassian Cloud enforces HTTP 429 rate limits; throttle to ~1–2 requests/second and honor Retry-After headers.

Input parameters

Name	Type	Required	Description
type	string	No	Type of content to return: page, blogpost, attachment.
limit	integer	No	Maximum number of items to return per page. Confluence caps at 200.
start	integer	No	Zero-based index of the first item to return (pagination offset).
status	string	No	Status of the content to return: current, trashed, draft, historical.
spaceKey	string	Yes	Key of the space to retrieve content from.
postingDay	string	No	For blogposts, filter by publish date (ISO date, yyyy-MM-dd).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Space Properties

CONFLUENCE_GET_SPACE_PROPERTIES

Tool to get properties of a Confluence space. Use when you need to retrieve custom metadata or settings stored as space properties.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the space to get properties for.
key	array	No	Filter by property key(s). If not provided, returns all properties.
limit	integer	No	Maximum number of properties to return per page. Confluence caps at 200.
start	integer	No	Zero-based index of the first item to return (pagination offset).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Spaces

CONFLUENCE_GET_SPACES

Tool to retrieve a paginated list of Confluence spaces with optional filtering. Paginate by incrementing start in steps of limit until fewer results than limit are returned. Results are scoped to spaces visible to the authenticated user. Use spaceKey or numeric space ID (not display name) for stable identification in downstream calls. Combined filters apply as AND logic.

Input parameters

Name	Type	Required	Description
type	string	No	Type of space: global or personal.
label	array	No	Filter by labels; spaces must have at least one of these labels.
limit	integer	No	Maximum number of spaces to return per page. Confluence caps at 200.
start	integer	No	Zero-based index of the first item to return (pagination offset).
expand	array	No	Properties to expand in response (e.g., description, icon, metadata).
status	string	No	Status of space: current (active) or archived.
spaceKey	array	No	Filter by space key(s); accepts one or more canonical space keys.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Tasks

CONFLUENCE_GET_TASKS

Tool to list Confluence tasks (action items) with filtering by assignee, creator, space, page, blog post, status, and dates. Use when you need to retrieve user action items without unreliable keyword searching for “TODO”.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of tasks to return per page. Confluence caps at 250.
cursor	string	No	Opaque pagination cursor. Use the next link from a previous response to continue.
status	string	No	Filter tasks by status (e.g., complete, incomplete).
page_id	string	No	Filter by page ID(s). Provide a single ID or a list of IDs.
task_id	string	No	Filter by specific task ID(s). Provide a single ID or a list of IDs.
space_id	string	No	Filter by space ID(s). Provide a single ID or a list of IDs.
created_by	string	No	Filter by task creator(s). Provide Atlassian account ID(s).
assigned_to	string	No	Filter by task assignee(s). Provide Atlassian account ID(s).
blogpost_id	string	No	Filter by blog post ID(s). Provide a single ID or a list of IDs.
body_format	string	No	Body representation to include in task results. Allowed values: storage or atlas_doc_format.
completed_by	string	No	Filter by who completed the task(s). Provide Atlassian account ID(s).
include_blank_tasks	boolean	No	Whether to include tasks that have no content or are blank.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Anonymous User

CONFLUENCE_GET_USER_ANONYMOUS

Tool to retrieve information about the anonymous user. Use when you need to obtain guest user details before unauthenticated interactions.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Search Content

CONFLUENCE_SEARCH_CONTENT

Searches for content by filtering pages from the Confluence v2 API with intelligent ranking. Since the native search endpoint is deprecated, this action: (1) fetches pages from the v2 pages endpoint with pagination (up to 300 pages), (2) applies intelligent client-side filtering with relevance scoring, (3) returns results ranked by match quality (exact phrase > all words > partial matches). NOTE: Only page titles are searched — queries matching only body content return no results.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of results to return.
query	string	Yes	Search query to find matching pages. The search looks for this text in page titles with intelligent matching: (1) exact phrase matches (highest priority), (2) all words present anywhere in title (medium priority), (3) partial word matches (lowest priority). Case-insensitive and supports multiple words.
start	integer	No	Starting index for pagination.
expand	string	No	Comma-separated list of properties to expand in the response.
spaceKey	string	No	Limit search to a specific space by space key. Inspect spaceId in returned results to confirm scope.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Search Users

CONFLUENCE_SEARCH_USERS

Searches for users using user-specific queries from the Confluence Query Language (CQL).

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of users per result to return.
cursor	string	No	Used for pagination. The cursor for the next page of results.
accountId	string	No	Filter by user account ID.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Blogpost

CONFLUENCE_UPDATE_BLOGPOST

Tool to update a Confluence blog post’s title or content. Use when you need to modify an existing blog post. Ensure you have the latest version number before calling.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the blog post to update.
body	object	Yes	New content for the blog post body. Provide the body in storage format.
title	string	Yes	New title for the blog post.
status	string	No	Status of the blog post. Defaults to current if not provided. Values: current, draft.
spaceId	string	Yes	ID of the space containing the blog post.
version	object	Yes	Version object containing the new version number and optional metadata.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Blogpost Property

CONFLUENCE_UPDATE_BLOGPOST_PROPERTY

Tool to update a property of a specified blog post. Use when you need to modify custom metadata on a blog post.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the Confluence blog post to update.
value	string	Yes	New JSON string value for the specified property.
propertyId	string	Yes	The ID of the blog post property to update. Can be a numeric ID or a property key string.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Page Content Property

CONFLUENCE_UPDATE_CONTENT_PROPERTY_FOR_PAGE_BY_ID

Tool to update a content property on a Confluence page. Use when you need to modify an existing metadata property by its ID.

Input parameters

Name	Type	Required	Description
value	string	Yes	New JSON string value for the specified property.
pageId	string	Yes	ID of the Confluence page to update the property on.
propertyId	string	Yes	ID of the content property to update on the page. Can be a numeric ID or a property key string.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Whiteboard Content Property

CONFLUENCE_UPDATE_CONTENT_PROPERTY_FOR_WHITEBOARD_BY_ID

Tool to update a content property on a whiteboard. Use when you need to modify metadata on a Confluence whiteboard.

Input parameters

Name	Type	Required	Description
value	string	Yes	New JSON string value for the specified content property.
propertyId	string	Yes	ID of the content property to update on the whiteboard. Can be a numeric ID or a property key string.
whiteboardId	string	Yes	ID of the Confluence whiteboard containing the property to update.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Page

CONFLUENCE_UPDATE_PAGE

Tool to update an existing Confluence page, replacing the entire page content. Use when you need to modify existing documentation or content.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the page to update. Must be a string; convert from numeric IDs returned by CONFLUENCE_GET_PAGE_BY_ID before passing.
body	object	Yes	Updated content body of the page. Requires value (the content in the specified format) and representation (storage for Confluence storage format/XHTML, or atlas_doc_format for Atlassian Document Format/ADF). Replaces the entire page content — always send complete desired content. Provide exactly one representation key (storage, atlas_doc_format, or wiki) whose value matches the representation field; mismatched or multiple keys cause validation errors.
title	string	Yes	Updated title of the page. IMPORTANT: Confluence enforces unique page titles within each space. Changing the title to one that already exists in the same space will fail.
spaceId	string	No	ID of the space containing the page. Optional if the page’s space doesn’t need to be changed.
version	object	Yes	Version information for the update. Must include number set to exactly current_version + 1. Fetch the current version via CONFLUENCE_GET_PAGE_BY_ID before updating. On a 409 conflict, refetch the latest version and retry.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Space Property

CONFLUENCE_UPDATE_SPACE_PROPERTY

Tool to update a space property. Use when you need to modify custom metadata stored on a Confluence space (requires fetching the current property version first).

Input parameters

Name	Type	Required	Description
value	string	Yes	New JSON string value for the specified space property.
spaceId	integer	Yes	The ID of the space the property belongs to.
propertyId	string	Yes	The ID of the space property to update. Can be a numeric ID or a property key string.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Task

CONFLUENCE_UPDATE_TASK

Tool to update a Confluence task status. Use when you need to mark tasks as complete or incomplete in workflows or dashboards.

Input parameters

Name	Type	Required	Description
id	string	Yes	ID of the task to update.
status	string	Yes	Status of the task. Values: complete, incomplete.
body_format	string	No	Optional body format for the response. Values: storage, atlas_doc_format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.