Confluence

Confluence Content Properties API

The Content Properties API from Confluence — 18 operation(s) for content properties.

GitHub OpenAPI

Operations 45

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 /attachments/{attachment-id}/properties List content properties on an attachment · Get content properties for attachment #
Ask an LLM
“What custom metadata properties are stored on a Confluence attachment?”
“Can I filter an attachment's content properties by a specific key?”
Tell an agent
List all content properties on attachment {attachment_id}.
Find the property with key {key} on attachment {attachment_id}.
POST /attachments/{attachment-id}/properties Add a content property to an attachment · Create content property for attachment #
Ask an LLM
“How do I store my own key-value metadata on an uploaded attachment?”
“Can an app attach a JSON property to a file attachment?”
Tell an agent
Create a property {key} with value {value} on attachment {attachment_id}.
Tag attachment {attachment_id} with a new content property named {key}.
GET /attachments/{attachment-id}/properties/{property-id} Get one attachment content property by id · Get content property for attachment by id #
Ask an LLM
“What value does a particular content property hold on an attachment?”
“Can I fetch a single attachment property if I already know its property id?”
Tell an agent
Show property {property_id} on attachment {attachment_id}.
Read the value of attachment property {property_id} from attachment {attachment_id}.
PUT /attachments/{attachment-id}/properties/{property-id} Update an attachment content property · Update content property for attachment by id #
Ask an LLM
“How do I change the value of an existing property on an attachment?”
“Does updating an attachment property require a version number?”
Tell an agent
Set attachment {attachment_id} property {property_id} to {value}.
Update property {property_id} on attachment {attachment_id} as version {version}.
DELETE /attachments/{attachment-id}/properties/{property-id} Delete a content property from an attachment · Delete content property for attachment by id #
Ask an LLM
“Can I remove a stored metadata property from an attachment?”
“What happens to an attachment when I delete one of its content properties?”
Tell an agent destructive · confirm first
Delete property {property_id} from attachment {attachment_id}.
Remove the content property {property_id} attached to file {attachment_id}.
GET /blogposts/{blogpost-id}/properties List content properties on a blog post · Get content properties for blog post #
Ask an LLM
“Which content properties have apps stored on a Confluence blog post?”
“Can I page through a blog post's properties with a cursor?”
Tell an agent
List the content properties on blog post {blogpost_id}.
Look up the blog post property with key {key} on blog post {blogpost_id}.
POST /blogposts/{blogpost-id}/properties Add a content property to a blog post · Create content property for blog post #
Ask an LLM
“How do I save custom metadata against a blog post?”
“Can I add a new key-value property to an existing blog post?”
Tell an agent
Create property {key} with value {value} on blog post {blogpost_id}.
Add a content property called {key} to blog post {blogpost_id}.
GET /blogposts/{blogpost-id}/properties/{property-id} Get one blog post content property by id · Get content property for blog post by id #
Ask an LLM
“What is stored in a specific property on a blog post?”
“Can I retrieve a blog post property directly by its property id?”
Tell an agent
Show property {property_id} on blog post {blogpost_id}.
Get the value of blog post property {property_id} for post {blogpost_id}.
PUT /blogposts/{blogpost-id}/properties/{property-id} Update a blog post content property · Update content property for blog post by id #
Ask an LLM
“How do I overwrite the value of a property already on a blog post?”
“Which version number must I send when editing a blog post property?”
Tell an agent
Set blog post {blogpost_id} property {property_id} to {value}.
Update property {property_id} on blog post {blogpost_id} as version {version}.
DELETE /blogposts/{blogpost-id}/properties/{property-id} Delete a content property from a blog post · Delete content property for blogpost by id #
Ask an LLM
“Can I remove an app's metadata property from a blog post?”
“What permission do I need to delete a property on a blog post?”
Tell an agent destructive · confirm first
Delete property {property_id} from blog post {blogpost_id}.
Remove the content property {property_id} stored on blog post {blogpost_id}.
GET /custom-content/{custom-content-id}/properties List content properties on custom content · Get content properties for custom content #
Ask an LLM
“What properties are stored on a piece of custom content?”
“Can I sort the properties of a custom content item?”
Tell an agent
List the content properties on custom content {custom_content_id}.
Find the custom content property with key {key} on item {custom_content_id}.
POST /custom-content/{custom-content-id}/properties Add a content property to custom content · Create content property for custom content #
Ask an LLM
“How do I attach key-value metadata to an app's custom content item?”
“Can I create a new property on custom content my app owns?”
Tell an agent
Create property {key} with value {value} on custom content {custom_content_id}.
Add a content property named {key} to custom content {custom_content_id}.
GET /custom-content/{custom-content-id}/properties/{property-id} Get one custom content property by id · Get content property for custom content by id #
Ask an LLM
“What value is held in a particular property on my custom content?”
“Can I read one custom content property by its id instead of listing all of them?”
Tell an agent
Show property {property_id} on custom content {custom_content_id}.
Read custom content property {property_id} from item {custom_content_id}.
PUT /custom-content/{custom-content-id}/properties/{property-id} Update a custom content property · Update content property for custom content by id #
Ask an LLM
“How do I change a property value on a custom content item?”
“Do I have to bump the version when I edit a custom content property?”
Tell an agent
Set custom content {custom_content_id} property {property_id} to {value}.
Update property {property_id} on custom content {custom_content_id} as version {version}.
DELETE /custom-content/{custom-content-id}/properties/{property-id} Delete a content property from custom content · Delete content property for custom content by id #
Ask an LLM
“Can I remove a stored property from a piece of custom content?”
“Who is allowed to delete properties on custom content?”
Tell an agent destructive · confirm first
Delete property {property_id} from custom content {custom_content_id}.
Remove content property {property_id} from custom content item {custom_content_id}.
GET /pages/{page-id}/properties List content properties on a page · Get content properties for page #
Ask an LLM
“Which content properties are set on a Confluence page?”
“Can I look up a page property by key without knowing its id?”
Tell an agent
List the content properties on page {page_id}.
Find the page property with key {key} on page {page_id}.
POST /pages/{page-id}/properties Add a content property to a page · Create content property for page #
Ask an LLM
“How do I store app data as a property on a page?”
“Can I add a custom key-value property to a page without editing its body?”
Tell an agent
Create property {key} with value {value} on page {page_id}.
Add a content property called {key} to page {page_id}.
GET /pages/{page-id}/properties/{property-id} Get one page content property by id · Get content property for page by id #
Ask an LLM
“What value does a specific property on a page currently hold?”
“Can I fetch a single page property using its property id?”
Tell an agent
Show property {property_id} on page {page_id}.
Read page property {property_id} from page {page_id}.
PUT /pages/{page-id}/properties/{property-id} Update a page content property · Update content property for page by id #
Ask an LLM
“How do I change the value of a property already stored on a page?”
“Does editing a page property need the next version number?”
Tell an agent
Set page {page_id} property {property_id} to {value}.
Update property {property_id} on page {page_id} as version {version}.
DELETE /pages/{page-id}/properties/{property-id} Delete a content property from a page · Delete content property for page by id #
Ask an LLM
“Can I remove a content property from a page while keeping the page?”
“What permission is needed to delete a property on a page?”
Tell an agent destructive · confirm first
Delete property {property_id} from page {page_id}.
Remove the content property {property_id} stored on page {page_id}.
GET /whiteboards/{id}/properties List content properties on a whiteboard · Get content properties for whiteboard #
Ask an LLM
“What content properties are stored on a Confluence whiteboard?”
“Can I limit how many whiteboard properties come back per page?”
Tell an agent
List the content properties on whiteboard {id}.
Find the whiteboard property with key {key} on whiteboard {id}.
POST /whiteboards/{id}/properties Add a content property to a whiteboard · Create content property for whiteboard #
Ask an LLM
“How do I attach custom metadata to a whiteboard?”
“Can an integration add a key-value property to a whiteboard?”
Tell an agent
Create property {key} with value {value} on whiteboard {id}.
Add a content property called {key} to whiteboard {id}.
GET /whiteboards/{whiteboard-id}/properties/{property-id} Get one whiteboard content property by id · Get content property for whiteboard by id #
Ask an LLM
“What is stored in a particular property on a whiteboard?”
“Can I read a whiteboard property directly by its property id?”
Tell an agent
Show property {property_id} on whiteboard {whiteboard_id}.
Read whiteboard property {property_id} from whiteboard {whiteboard_id}.
PUT /whiteboards/{whiteboard-id}/properties/{property-id} Update a whiteboard content property · Update content property for whiteboard by id #
Ask an LLM
“How do I change the value of a property on a whiteboard?”
“Is a version number required to edit a whiteboard property?”
Tell an agent
Set whiteboard {whiteboard_id} property {property_id} to {value}.
Update property {property_id} on whiteboard {whiteboard_id} as version {version}.
DELETE /whiteboards/{whiteboard-id}/properties/{property-id} Delete a content property from a whiteboard · Delete content property for whiteboard by id #
Ask an LLM
“Can I remove a stored property from a whiteboard?”
“Who can delete content properties on a whiteboard?”
Tell an agent destructive · confirm first
Delete property {property_id} from whiteboard {whiteboard_id}.
Remove content property {property_id} stored on whiteboard {whiteboard_id}.
GET /databases/{id}/properties List content properties on a database · Get content properties for database #
Ask an LLM
“Which content properties are set on a Confluence database?”
“Can I filter a database's properties by key?”
Tell an agent
List the content properties on database {id}.
Find the database property with key {key} on database {id}.
POST /databases/{id}/properties Add a content property to a database · Create content property for database #
Ask an LLM
“How do I store custom metadata on a Confluence database?”
“Can I add a new key-value property to a database?”
Tell an agent
Create property {key} with value {value} on database {id}.
Add a content property called {key} to database {id}.
GET /databases/{database-id}/properties/{property-id} Get one database content property by id · Get content property for database by id #
Ask an LLM
“What value does a particular property hold on a database?”
“Can I fetch one database property by its property id?”
Tell an agent
Show property {property_id} on database {database_id}.
Read database property {property_id} from database {database_id}.
PUT /databases/{database-id}/properties/{property-id} Update a database content property · Update content property for database by id #
Ask an LLM
“How do I change a property value stored on a database?”
“Which version should I send when updating a database property?”
Tell an agent
Set database {database_id} property {property_id} to {value}.
Update property {property_id} on database {database_id} as version {version}.
DELETE /databases/{database-id}/properties/{property-id} Delete a content property from a database · Delete content property for database by id #
Ask an LLM
“Can I remove a content property from a database without touching its data?”
“What permission is needed to delete a database property?”
Tell an agent destructive · confirm first
Delete property {property_id} from database {database_id}.
Remove content property {property_id} stored on database {database_id}.
GET /embeds/{id}/properties List content properties on a Smart Link · Get content properties for Smart Link in the content tree #
Ask an LLM
“What content properties are stored on a Smart Link in the content tree?”
“Can I sort or paginate the properties of a Smart Link embed?”
Tell an agent
List the content properties on Smart Link {id}.
Find the Smart Link property with key {key} on embed {id}.
POST /embeds/{id}/properties Add a content property to a Smart Link · Create content property for Smart Link in the content tree #
Ask an LLM
“How do I store custom metadata on a Smart Link in the page tree?”
“Can I add a key-value property to an embedded Smart Link?”
Tell an agent
Create property {key} with value {value} on Smart Link {id}.
Add a content property called {key} to Smart Link embed {id}.
GET /embeds/{embed-id}/properties/{property-id} Get one Smart Link content property by id · Get content property for Smart Link in the content tree by id #
Ask an LLM
“What value is stored in a specific property on a Smart Link?”
“Can I retrieve a Smart Link property directly by its id?”
Tell an agent
Show property {property_id} on Smart Link {embed_id}.
Read Smart Link property {property_id} from embed {embed_id}.
PUT /embeds/{embed-id}/properties/{property-id} Update a Smart Link content property · Update content property for Smart Link in the content tree by id #
Ask an LLM
“How do I change a property value on a Smart Link in the content tree?”
“Does editing a Smart Link property need a version number?”
Tell an agent
Set Smart Link {embed_id} property {property_id} to {value}.
Update property {property_id} on Smart Link {embed_id} as version {version}.
DELETE /embeds/{embed-id}/properties/{property-id} Delete a content property from a Smart Link · Delete content property for Smart Link in the content tree by id #
Ask an LLM
“Can I remove a stored property from a Smart Link embed?”
“Who is allowed to delete properties on a Smart Link?”
Tell an agent destructive · confirm first
Delete property {property_id} from Smart Link {embed_id}.
Remove content property {property_id} stored on Smart Link embed {embed_id}.
GET /folders/{id}/properties List content properties on a folder · Get content properties for folder #
Ask an LLM
“Which content properties are set on a Confluence folder?”
“Can I look up a folder property by key?”
Tell an agent
List the content properties on folder {id}.
Find the folder property with key {key} on folder {id}.
POST /folders/{id}/properties Add a content property to a folder · Create content property for folder #
Ask an LLM
“How do I attach custom metadata to a folder in a space?”
“Can I add a new key-value property to a folder?”
Tell an agent
Create property {key} with value {value} on folder {id}.
Add a content property called {key} to folder {id}.
GET /folders/{folder-id}/properties/{property-id} Get one folder content property by id · Get content property for folder by id #
Ask an LLM
“What is stored in a particular property on a folder?”
“Can I fetch a single folder property by its property id?”
Tell an agent
Show property {property_id} on folder {folder_id}.
Read folder property {property_id} from folder {folder_id}.
PUT /folders/{folder-id}/properties/{property-id} Update a folder content property · Update content property for folder by id #
Ask an LLM
“How do I change a property value stored on a folder?”
“Which version do I send when editing a folder property?”
Tell an agent
Set folder {folder_id} property {property_id} to {value}.
Update property {property_id} on folder {folder_id} as version {version}.
DELETE /folders/{folder-id}/properties/{property-id} Delete a content property from a folder · Delete content property for folder by id #
Ask an LLM
“Can I remove a content property from a folder?”
“What permission is required to delete a property on a folder?”
Tell an agent destructive · confirm first
Delete property {property_id} from folder {folder_id}.
Remove content property {property_id} stored on folder {folder_id}.
GET /comments/{comment-id}/properties List content properties on a comment · Get content properties for comment #
Ask an LLM
“What content properties are stored on a Confluence comment?”
“Can I filter a comment's properties by key?”
Tell an agent
List the content properties on comment {comment_id}.
Find the comment property with key {key} on comment {comment_id}.
POST /comments/{comment-id}/properties Add a content property to a comment · Create content property for comment #
Ask an LLM
“How do I attach app metadata to a comment?”
“Can I add a key-value property to a footer or inline comment?”
Tell an agent
Create property {key} with value {value} on comment {comment_id}.
Add a content property called {key} to comment {comment_id}.
GET /comments/{comment-id}/properties/{property-id} Get one comment content property by id · Get content property for comment by id #
Ask an LLM
“What value does a specific property on a comment hold?”
“Can I read a comment property directly by its property id?”
Tell an agent
Show property {property_id} on comment {comment_id}.
Read comment property {property_id} from comment {comment_id}.
PUT /comments/{comment-id}/properties/{property-id} Update a comment content property · Update content property for comment by id #
Ask an LLM
“How do I change the value of a property stored on a comment?”
“Is a version number needed to update a comment property?”
Tell an agent
Set comment {comment_id} property {property_id} to {value}.
Update property {property_id} on comment {comment_id} as version {version}.
DELETE /comments/{comment-id}/properties/{property-id} Delete a content property from a comment · Delete content property for comment by id #
Ask an LLM
“Can I remove a stored property from a comment?”
“Who can delete content properties attached to a comment?”
Tell an agent destructive · confirm first
Delete property {property_id} from comment {comment_id}.
Remove content property {property_id} stored on comment {comment_id}.

Documentation

📖
APIReference
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/security-overview/
📖
GettingStarted
https://developer.atlassian.com/cloud/confluence/getting-started/
📖
APIReference
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/

Specifications

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

Other Resources

🔗
Postman
https://developer.atlassian.com/cloud/confluence/confcloud.2.postman.json
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/collections/confluence-confcloud-v2.postman_collection.json

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-content-properties-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-content-properties-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluence Cloud REST API v2 Content Properties API
  description: This document describes Confluence's v2 APIs. This is intended to be an iteration on the existing Confluence Cloud REST API with improvements in both endpoint definitions and performance.
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  version: 2.0.0
servers:
- 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 (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-content-properties-api-openapi.yml