Confluence

Confluence Comment API

Create, retrieve, update, and delete comments on pages and blog posts

GitHub OpenAPI

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /pages/{id}/footer-comments List the footer comments on a page · Get Footer Comments for Page #
Ask an LLM
“How do I read the comments left at the bottom of a Confluence page?”
“Can I page through a page's footer comments with a limit and cursor?”
Tell an agent
Show the footer comments on page {id}.
Get the first {limit} footer comments on page {id} in storage format.
GET /pages/{id}/inline-comments List the inline comments on a page · Get Inline Comments for Page #
Ask an LLM
“Where can I see the comments people highlighted inside a specific page's text?”
“Which inline comments exist on one particular page?”
Tell an agent
List the inline comments anchored in page {id}.
Fetch up to {limit} inline comments from page {id}.
POST /footer-comments Add a footer comment to a page or blog post · Create Footer Comment #
Ask an LLM
“How do I post a comment at the bottom of a Confluence page?”
“Can I reply to an existing footer comment by giving its parent comment?”
Tell an agent
Add a footer comment saying {body} to page {pageId}.
Comment {body} at the bottom of blog post {blogPostId}.
GET /footer-comments List footer comments across the whole site · Get footer comments #
Ask an LLM
“Can I pull every footer comment across the site, not just one page?”
“Is there a way to sort all footer comments site-wide by creation date?”
Tell an agent
List all footer comments across the site.
Get all footer comments sorted by {sort}.
POST /inline-comments Add an inline comment to selected text · Create Inline Comment #
Ask an LLM
“How do I comment on a specific highlighted sentence in a page?”
“Can an inline comment be anchored to text in a blog post too?”
Tell an agent
Add an inline comment {body} on page {pageId} anchored to {inlineCommentProperties}.
Highlight {inlineCommentProperties} in blog post {blogPostId} and comment {body}.
GET /inline-comments List inline comments across the whole site · Get inline comments #
Ask an LLM
“Can I get every inline comment in the site in one list?”
“What does a site-wide listing of highlighted-text comments return?”
Tell an agent
List all inline comments across every page and blog post.
Get all inline comments sorted by {sort}, {limit} at a time.
GET /comments/{id} Get a comment by its id · Get Comment by Id #
Ask an LLM
“How do I look up a single comment when I only know its id, without knowing if it is footer or inline?”
“Can I fetch an older version of a comment?”
Tell an agent
Get comment {id} using the generic comments endpoint.
Show version {version} of comment {id}.
PUT /comments/{id} Edit a comment through the generic comments endpoint · Update Comment #
Ask an LLM
“How do I change the text of a comment by id when the version number must go up?”
“What version number do I need to send when editing a comment through the generic endpoint?”
Tell an agent
Change comment {id} to say {body} as version {version}.
Rewrite the text of comment {id} to {body}, bumping it to version {version}.
DELETE /comments/{id} Delete a comment through the generic endpoint · Delete Comment #
Ask an LLM
“How do I remove a comment by id without knowing whether it's footer or inline?”
“Can I delete any comment through the generic comments path?”
Tell an agent destructive · confirm first
Delete comment {id} via the generic comments endpoint.
Remove comment {id}.
GET /comments/{id}/children List replies to a comment · Get Child Comments #
Ask an LLM
“How can I see the replies under a comment when I don't know its type?”
“Which reply comments hang off a given comment id?”
Tell an agent
List the replies to comment {id} using the generic comments path.
Get up to {limit} child replies of comment {id}.
GET /attachments/{id}/footer-comments List comments on an attachment · Get attachment comments #
Ask an LLM
“How do I read the comments people left on an uploaded file?”
“Can I see comments on a specific version of an attachment?”
Tell an agent
Show the comments on attachment {id}.
List comments on version {version} of attachment {id}.
GET /custom-content/{id}/footer-comments List comments on custom content · Get custom content comments #
Ask an LLM
“How do I get the comments attached to an app's custom content item?”
“Can I sort the comments on a custom content item?”
Tell an agent
List the comments on custom content {id}.
Get comments on custom content {id} sorted by {sort}.
GET /blogposts/{id}/footer-comments List the footer comments on a blog post · Get footer comments for blog post #
Ask an LLM
“How do I read the comments at the bottom of a Confluence blog post?”
“Can I filter a blog post's footer comments by status?”
Tell an agent
Show the footer comments on blog post {id}.
List {status} footer comments on blog post {id}.
GET /blogposts/{id}/inline-comments List the inline comments on a blog post · Get inline comments for blog post #
Ask an LLM
“Which highlighted-text comments are on a blog post?”
“Can I see only the unresolved inline comments on a blog post?”
Tell an agent
List the inline comments on blog post {id}.
Get inline comments on blog post {id} with resolution status {resolution-status}.
GET /footer-comments/{comment-id} Get a footer comment by id · Get footer comment by id #
Ask an LLM
“How do I retrieve one footer comment along with its likes and versions?”
“Can I include a footer comment's properties and permitted operations when fetching it?”
Tell an agent
Get footer comment {comment-id}.
Fetch footer comment {comment-id} with its likes included.
PUT /footer-comments/{comment-id} Edit the text of a footer comment · Update footer comment #
Ask an LLM
“How do I edit what a footer comment says?”
“Do I need to bump the version when updating a footer comment?”
Tell an agent
Update footer comment {comment-id} to read {body}.
Save footer comment {comment-id} as version {version} with text {body}.
DELETE /footer-comments/{comment-id} Permanently delete a footer comment · Delete footer comment #
Ask an LLM
“Can a deleted footer comment be recovered afterwards?”
“How do I permanently remove a comment from the bottom of a page?”
Tell an agent destructive · confirm first
Permanently delete footer comment {comment-id}.
Remove footer comment {comment-id} from its page.
GET /footer-comments/{id}/children List replies to a footer comment · Get children footer comments #
Ask an LLM
“How do I see the reply thread under a footer comment?”
“Can I sort the replies to a footer comment?”
Tell an agent
List the replies to footer comment {id}.
Get replies to footer comment {id} sorted by {sort}.
GET /inline-comments/{comment-id} Get an inline comment by id · Get inline comment by id #
Ask an LLM
“How do I retrieve a single inline comment and the text it's anchored to?”
“Can I fetch an inline comment together with its version history?”
Tell an agent
Get inline comment {comment-id}.
Show version {version} of inline comment {comment-id}.
PUT /inline-comments/{comment-id} Edit or resolve an inline comment · Update inline comment #
Ask an LLM
“How do I mark an inline comment as resolved?”
“Can I change the wording of an inline comment after posting it?”
Tell an agent
Resolve inline comment {comment-id}.
Set resolved to {resolved} on inline comment {comment-id}.
DELETE /inline-comments/{comment-id} Permanently delete an inline comment · Delete inline comment #
Ask an LLM
“How do I permanently delete a highlighted-text comment?”
“Is deleting an inline comment reversible?”
Tell an agent destructive · confirm first
Permanently delete inline comment {comment-id}.
Remove the inline comment {comment-id} from its page.
GET /inline-comments/{id}/children List replies to an inline comment · Get children inline comments #
Ask an LLM
“How do I read the reply thread on an inline comment?”
“Can I limit how many inline comment replies come back per page?”
Tell an agent
List the replies to inline comment {id}.
Get the first {limit} replies under inline comment {id}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/#auth
📖
GettingStarted
https://developer.atlassian.com/cloud/confluence/getting-started/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-comment-api-openapi.yml

Code Examples

💻
CodeExamples
https://developer.atlassian.com/cloud/confluence/rest-api-examples/

Other Resources

🔗
ChangeLog
https://developer.atlassian.com/cloud/confluence/changelog/
🔗
SDKs
https://www.postman.com/api-evangelist/atlassian-confluence/collection/k3y2x73/atlassian-confluence-cloud
🔗
SDKs
https://www.postman.com/api-reference-library/atlassian-cloud/collection/0a0hjxk/the-confluence-cloud-rest-api-v2

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/confluence:confluence-comment-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

confluence-comment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluence Comment API
  version: 2.0.0
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  description: 'Operations tagged Comment across 2 of this provider''s published API definitions: confluence-cloud-v2.yml, confluence-rest-v2-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domain}.atlassian.net/wiki/api/v2
  description: Confluence Cloud
  variables:
    domain:
      default: your-domain
      description: Your Atlassian Cloud site domain
- url: https://{your-domain}/wiki/api/v2
  variables:
    your-domain:
      default: no-default
      description: Specific domain of the Confluence site being used. Must be provided.
tags:


# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-comment-api-openapi.yml