Confluence

Learn how to use Confluence with Composio

Overview

Enum

CONFLUENCE

Description

A tool for team collaboration and knowledge management.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read:content:confluence,read:content-details:confluence,write:content:confluence,delete:content:confluence,read:space-details:confluence,read:analytics.content:confluence,read:audit-log:confluence,write:audit-log:confluence,read:configuration:confluence,write:configuration:confluence,read:page:confluence,write:page:confluence,delete:page:confluence,read:blogpost:confluence,write:blogpost:confluence,delete:blogpost:confluence,read:whiteboard:confluence,write:whiteboard:confluence,delete:whiteboard:confluence,read:database:confluence,write:database:confluence,delete:database:confluence,read:embed:confluence,write:embed:confluence,delete:embed:confluence,read:folder:confluence,write:folder:confluence,delete:folder:confluence,read:custom-content:confluence,write:custom-content:confluence,delete:custom-content:confluence,read:attachment:confluence,write:attachment:confluence,delete:attachment:confluence,read:comment:confluence,write:comment:confluence,delete:comment:confluence,read:template:confluence,write:template:confluence,read:label:confluence,write:label:confluence,read:content.permission:confluence,read:content.property:confluence,write:content.property:confluence,read:content.restriction:confluence,write:content.restriction:confluence,read:content.metadata:confluence,read:watcher:confluence,write:watcher:confluence,read:group:confluence,write:group:confluence,read:inlinetask:confluence,write:inlinetask:confluence,read:relation:confluence,write:relation:confluence,read:space:confluence,write:space:confluence,delete:space:confluence,read:space.permission:confluence,write:space.permission:confluence,read:space.property:confluence,write:space.property:confluence,read:user.property:confluence,write:user.property:confluence,read:space.setting:confluence,write:space.setting:confluence,read:user:confluence,read:task:confluence,write:task:confluence,offline_access

Actions

Creates a new blog post in the space specified by the spaceid. by default this will create the blog post as a non-draft, unless the status is specified as draft. if creating a non-draft, the title must not be empty. currently only supports the storage representation specified in the body.representation enums below

Action Parameters

private
boolean
spaceId
stringRequired
status
string
title
string
body
object
createdAt
string

Action Response

data
object
successful
boolean
error

Deletes a content property for a comment by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the comment.

Action Parameters

comment__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the count of likes of specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the blog post and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Resets the classification level for a specific blog post for the space default classification level. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the blog post.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Returns the root footer comments of specific blog post. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the blog post and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
status
array
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Update a blog post by id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post and its corresponding space. permission to update blog posts in the space.

Action Parameters

id
stringRequired
status
stringRequired
title
stringRequired
spaceId
string
body
objectRequired
version__number
integer
version__message
string
createdAt
string

Action Response

data
object
successful
boolean
error

Creates a new content property for an attachment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the attachment.

Action Parameters

attachment__id
stringRequired
key
string
value

Action Response

data
object
successful
boolean
error

Retrieves the available space permissions. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site.

Action Parameters

cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page.

Action Parameters

page__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Update a content property for a folder by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the folder.

Action Parameters

folder__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Returns the labels of space content (pages, blogposts etc). the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the space. only labels that the user has permission to view will be returned.

Action Parameters

id
integerRequired
prefix
stringDefaults to my, team
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Resets the classification level for a specific database for the space default classification level. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the database.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Returns the attachments of specific custom content. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the custom content and its corresponding space.

Action Parameters

id
integerRequired
sort
string
cursor
string
status
array
mediaType
string
filename
string
limit
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Delete a whiteboard by id. deleting a whiteboard moves the whiteboard to the trash, where it can be restored later [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the whiteboard and its corresponding space. permission to delete whiteboards in the space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves content properties tied to a specified folder. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the folder.

Action Parameters

id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the comments of the specific attachment. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment and its corresponding containers.

Action Parameters

id
stringRequired
body__format
string
cursor
string
limit
integerDefaults to 25
sort
string
version
integer

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all ancestors for a given whiteboard by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as get whiteboard by id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). permission to view the whiteboard and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns a specific piece of custom content. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).

Action Parameters

id
integerRequired
body__format
string
version
integer
include__labels
boolean
include__properties
boolean
include__operations
boolean
include__versions
boolean
include__version
booleanDefaults to True
include__collaborators
boolean

Action Response

data
object
successful
boolean
error

Returns a specific attachment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment’s container.

Action Parameters

id
stringRequired
version
integer
include__labels
boolean
include__properties
boolean
include__operations
boolean
include__versions
boolean
include__version
booleanDefaults to True
include__collaborators
boolean

Action Response

data
object
successful
boolean
error

Retrieves version details for the specified attachment and version number. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment.

Action Parameters

attachment__id
stringRequired
version__number
integerRequired

Action Response

data
object
successful
boolean
error

Creates a new content property for a piece of custom content. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the custom content.

Action Parameters

custom__content__id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Returns the root inline comments of specific blog post. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the blog post and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
status
array
resolution__status
array
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Update a custom content by id. spaceid is always required and maximum one of pageid, blogpostid, or customcontentid is allowed in the request body. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space. permission to update custom content in the space.

Action Parameters

id
stringRequired
type
stringRequired
status
stringRequired
spaceId
string
pageId
string
blogPostId
string
customContentId
string
title
stringRequired
body
objectRequired
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Deletes a content property for a blogpost by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the blog post.

Action Parameters

blogpost__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieve a space property by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and ‘view’ permission for the space.

Action Parameters

space__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the classification level for a specific database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the database.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified custom content. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page.

Action Parameters

custom__content__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all child pages for given page id. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only pages that the user has permission to view will be returned.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Creates a whiteboard in the space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the corresponding space. permission to create a whiteboard in the space.

Action Parameters

private
boolean
spaceId
stringRequired
title
string
parentId
string
templateKey
string
locale
string

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the database and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves all content properties tied to a specified attachment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment.

Action Parameters

attachment__id
stringRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Update a content property for a piece of custom content by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the custom content.

Action Parameters

custom__content__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Retrieves all content properties tied to a specified blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post.

Action Parameters

blogpost__id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the comments of the specific custom content. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content and its corresponding containers.

Action Parameters

id
integerRequired
body__format
string
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific attachment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the parent content of the attachment and its corresponding space.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified attachment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment.

Action Parameters

attachment__id
stringRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Creates a new space property. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and ‘admin’ permission for the space.

Action Parameters

space__id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Returns all custom content for a given type within a given space. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content and the corresponding space.

Action Parameters

id
integerRequired
type
stringRequired
cursor
string
limit
integerDefaults to 25
body__format
string

Action Response

data
object
successful
boolean
error

Update a content property for a whiteboard by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the whiteboard.

Action Parameters

whiteboard__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Returns all child custom content for given custom content id. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only custom content that the user has permission to view will be returned.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Returns all properties for the given space. space properties are a key-value storage associated with a space. the limit parameter specifies the maximum number of results returned in a single response. use the link response header to paginate through additional results. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and ‘view’ permission for the space.

Action Parameters

space__id
integerRequired
key
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified folder. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the folder.

Action Parameters

folder__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Creates a new content property for a whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the whiteboard.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Deletes a content property for a whiteboard by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the whiteboard.

Action Parameters

whiteboard__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all ancestors for a given page by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as get page by id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission).

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Creates a new content property for a folder. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the folder.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the comment.

Action Parameters

comment__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Searches for content using the confluence query language (cql).

Action Parameters

cql
stringRequired
cqlcontext
object
cursor
string
next
boolean
prev
boolean
limit
integerDefaults to 25
start
integer
includeArchivedSpaces
boolean
excludeCurrentSpaces
boolean
excerpt
stringDefaults to highlight
sitePermissionTypeFilter
stringDefaults to none
expand
array

Action Response

data
object
successful
boolean
error

Returns the attachments of specified label. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment and its corresponding space.

Action Parameters

id
integerRequired
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves the versions of the specified inline comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blog post and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Delete a database by id. deleting a database moves the database to the trash, where it can be restored later [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the database and its corresponding space. permission to delete databases in the space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves content properties tied to a specified whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the whiteboard.

Action Parameters

id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns all ancestors for a given folder by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as get folder by id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). permission to view the folder and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the classification level for a specific whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the whiteboard.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the labels for a specific piece of custom content. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content and its corresponding space. only labels that the user has permission to view will be returned.

Action Parameters

id
integerRequired
prefix
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns a specific task. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the containing page or blog post and its corresponding space.

Action Parameters

id
integerRequired
body__format
string

Action Response

data
object
successful
boolean
error

Creates a new property for a blogpost. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the blog post.

Action Parameters

blogpost__id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Converts a list of content ids into their associated content types. this is useful for users migrating from v1 to v2 who may have stored just content ids without their associated type. this will return types as they should be used in v2. notably, this will return inline-comment for inline comments and footer-comment for footer comments, which is distinct from them both being represented by comment in v1. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the requested content. any content that the user does not have permission to view or does not exist will map to null in the response.

Action Parameters

contentIds
arrayRequired

Action Response

data
object
successful
boolean
error

Returns the classification level for a specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the page. ‘permission to edit the page is required if trying to view classification level for a draft.

Action Parameters

id
integerRequired
status
stringDefaults to current

Action Response

data
object
successful
boolean
error

Deletes a content property for a page by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the page.

Action Parameters

page__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns a specific space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the space.

Action Parameters

id
integerRequired
description__format
string
include__icon
boolean
include__operations
boolean
include__properties
boolean
include__permissions
boolean
include__role__assignments
boolean
include__labels
boolean

Action Response

data
object
successful
boolean
error

Returns a specific whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the whiteboard and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
object
successful
boolean
error

Create an inline comment. this can be at the top level (specifying pageid or blogpostid in the request body) or as a reply (specifying parentcommentid in the request body). note the inlinecommentproperties object in the request body is used to select the text the inline comment should be tied to. this is what determines the text highlighting when viewing a page in confluence. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.

Action Parameters

blogPostId
string
pageId
string
parentCommentId
string
body
object
inlineCommentProperties__textSelection
string
inlineCommentProperties__textSelectionMatchCount
integer
inlineCommentProperties__textSelectionMatchIndex
integer

Action Response

data
object
successful
boolean
error

Delete a folder by id. deleting a folder moves the folder to the trash, where it can be restored later [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the folder and its corresponding space. permission to delete folders in the space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the account ids of likes of specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the database.

Action Parameters

database__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all tasks. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only tasks that the user has permission to view will be returned.

Action Parameters

body__format
string
include__blank__tasks
boolean
status
string
task__id
array
space__id
array
page__id
array
blogpost__id
array
created__by
array
assigned__to
array
completed__by
array
created__at__from
integer
created__at__to
integer
due__at__from
integer
due__at__to
integer
completed__at__from
integer
completed__at__to
integer
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns all custom content for a given type. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).

Action Parameters

type
stringRequired
id
array
space__id
array
sort
string
cursor
string
limit
integerDefaults to 25
body__format
string

Action Response

data
object
successful
boolean
error

Returns the versions of specific custom content. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content and its corresponding page and space.

Action Parameters

custom__content__id
integerRequired
body__format
string
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Retrieves content properties tied to a specified custom content. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content.

Action Parameters

custom__content__id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Update an inline comment. this can be used to update the body text of a comment and/or to resolve the comment [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.

Action Parameters

comment__id
integerRequired
version__number
integer
version__message
string
body
object
resolved
boolean

Action Response

data
object
successful
boolean
error

Update a content property for a comment by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the comment.

Action Parameters

comment__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Update a content property for a page by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the page.

Action Parameters

page__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the parent content of the blog post and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves content properties tied to a specified database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the database.

Action Parameters

id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns all spaces. the results will be sorted by id ascending. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only spaces that the user has permission to view will be returned.

Action Parameters

ids
array
keys
array
type
string
status
string
labels
array
favorited__by
string
not__favorited__by
string
sort
string
description__format
string
include__icon
boolean
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Delete an attachment by id. deleting an attachment moves the attachment to the trash, where it can be restored later. to permanently delete an attachment (or “purge” it), the endpoint must be called on a trashed attachment with the following param purge=true. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the container of the attachment. permission to delete attachments in the space. permission to administer the space (if attempting to purge).

Action Parameters

id
integerRequired
purge
boolean

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the whiteboard.

Action Parameters

whiteboard__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Deletes an inline comment. this is a permanent deletion and cannot be reverted. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space. permission to delete comments in the space.

Action Parameters

comment__id
integerRequired

Action Response

data
object
successful
boolean
error

Creates a new content property for a database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the database.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Retrieves version details for the specified custom content and version number. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page.

Action Parameters

custom__content__id
integerRequired
version__number
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves version details for the specified page and version number. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page.

Action Parameters

page__id
integerRequired
version__number
integerRequired

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific inline comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the parent content of the inline comment and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves the available space roles. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site; if requesting a certain space’s roles, permission to view the space.

Action Parameters

space__id
string
role__type
string
principal__id
string
principal__type
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns all labels. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only labels that the user has permission to view will be returned.

Action Parameters

label__id
array
prefix
array
cursor
string
sort
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Update a content property for a database by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the database.

Action Parameters

database__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Update a task by id. this endpoint currently only supports updating task status. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the containing page or blog post and view its corresponding space.

Action Parameters

id
stringRequired
body__format
string
localId
string
spaceId
string
pageId
string
blogPostId
string
status
stringRequired
createdBy
string
assignedTo
string
completedBy
string
createdAt
string
updatedAt
string
dueAt
string
completedAt
string

Action Response

data
object
successful
boolean
error

Returns the labels of specific page. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space. only labels that the user has permission to view will be returned.

Action Parameters

id
integerRequired
prefix
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the account ids of likes of specific inline comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page/blogpost and its corresponding space.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Deletes a content property for a piece of custom content by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the custom content.

Action Parameters

custom__content__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves version details for the specified blog post and version number. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post.

Action Parameters

blogpost__id
integerRequired
version__number
integerRequired

Action Response

data
object
successful
boolean
error

Returns all spaces. the results will be sorted by id ascending. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: only apps can make this request. permission to access the confluence site (‘can use’ global permission). only spaces that the app has permission to view will be returned.

Action Parameters

ids
array
keys
array
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns a specific folder. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the folder and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
object
successful
boolean
error

Returns all blog posts. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only blog posts that the user has permission to view will be returned.

Action Parameters

id
array
space__id
array
sort
string
status
array
title
string
body__format
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the labels of specific attachment. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the parent content of the attachment and its corresponding space. only labels that the user has permission to view will be returned.

Action Parameters

id
integerRequired
prefix
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns a specific database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the database and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
object
successful
boolean
error

Returns the pages of specified label. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired
space__id
array
body__format
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the default classification level for a specific space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Deletes a content property for a folder by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the folder.

Action Parameters

folder__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all custom content for a given type within a given page. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content, the container of the custom content (page), and the corresponding space.

Action Parameters

id
integerRequired
type
stringRequired
sort
string
cursor
string
limit
integerDefaults to 25
body__format
string

Action Response

data
object
successful
boolean
error

Delete a blog post by id. by default this will delete blog posts that are non-drafts. to delete a blog post that is a draft, the endpoint must be called on a draft with the following param draft=true. discarded drafts are not sent to the trash and are permanently deleted. deleting a blog post that is not a draft moves the blog post to the trash, where it can be restored later. to permanently delete a blog post (or “purge” it), the endpoint must be called on a trashed blog post with the following param purge=true. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post and its corresponding space. permission to delete blog posts in the space. permission to administer the space (if attempting to purge).

Action Parameters

id
integerRequired
purge
boolean
draft
boolean

Action Response

data
object
successful
boolean
error

Returns the root inline comments of specific page. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
status
array
resolution__status
array
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves version details for the specified inline comment version. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blog post and its corresponding space.

Action Parameters

id
integerRequired
version__number
integerRequired

Action Response

data
object
successful
boolean
error

Update a page by id. when the “current” version is updated, the provided body content is considered as the latest version. this latest body content will be attempted to be merged into the draft version through a content reconciliation algorithm. if two versions are significantly diverged, the latest provided content may entirely override what was previously in the draft. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page and its corresponding space. permission to update pages in the space.

Action Parameters

id
stringRequired
status
stringRequired
title
stringRequired
spaceId
parentId
ownerId
body
objectRequired
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Returns the versions of specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the parent content of the page and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Invite a list of emails to the site. ignores all invalid emails and no action is taken for the emails that already have access to the site. note: this api is asynchronous and may take some time to complete. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission).

Action Parameters

emails
arrayRequired

Action Response

data
object
successful
boolean
error

Returns the account ids of likes of specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the blog post and its corresponding space.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the attachments of specific blog post. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the blog post and its corresponding space.

Action Parameters

id
integerRequired
sort
string
cursor
string
status
array
mediaType
string
filename
string
limit
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Returns all blog posts in a space. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and view the space. only blog posts that the user has permission to view will be returned.

Action Parameters

id
integerRequired
sort
string
status
array
title
string
body__format
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Updates the classification level for a specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to edit the blog post.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a content property for an attachment by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to attachment the page.

Action Parameters

attachment__id
stringRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the count of likes of specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all attachments. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the container of the attachment.

Action Parameters

sort
string
cursor
string
status
array
mediaType
string
filename
string
limit
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Returns all inline comments. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves an inline comment by id [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space.

Action Parameters

comment__id
integerRequired
body__format
string
version
integer
include__properties
boolean
include__operations
boolean
include__likes
boolean
include__versions
boolean
include__version
booleanDefaults to True

Action Response

data
object
successful
boolean
error

Returns all pages. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). only pages that the user has permission to view will be returned.

Action Parameters

id
array
space__id
array
sort
string
status
array
title
string
body__format
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns all custom content for a given type within a given blogpost. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the custom content, the container of the custom content (blog post), and the corresponding space.

Action Parameters

id
integerRequired
type
stringRequired
sort
string
cursor
string
limit
integerDefaults to 25
body__format
string

Action Response

data
object
successful
boolean
error

Returns the blogposts of specified label. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired
space__id
array
body__format
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Deletes a content property for a database by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the database.

Action Parameters

database__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Delete a custom content by id. deleting a custom content will either move it to the trash or permanently delete it (purge it), depending on the apisupport. to permanently delete a trashed custom content, the endpoint must be called with the following param purge=true. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space. permission to delete custom content in the space. permission to administer the space (if attempting to purge).

Action Parameters

id
integerRequired
purge
boolean

Action Response

data
object
successful
boolean
error

Returns the count of likes of specific inline comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page/blogpost and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the default classification level for a specific space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and ‘admin’ permission for the space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Update a content property for attachment by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the attachment.

Action Parameters

attachment__id
stringRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Retrieves the space role assignments. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the space.

Action Parameters

id
integerRequired
role__id
string
role__type
string
principal__id
string
principal__type
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Retrieves content properties tied to a specified page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page.

Action Parameters

page__id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the classification level for a specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the blog post. ‘permission to edit the blog post is required if trying to view classification level for a draft.

Action Parameters

id
integerRequired
status
stringDefaults to current

Action Response

data
object
successful
boolean
error

Creates a database in the space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the corresponding space. permission to create a database in the space.

Action Parameters

private
boolean
spaceId
stringRequired
title
string
parentId
string

Action Response

data
object
successful
boolean
error

Returns all pages in a space. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and ‘view’ permission for the space. only pages that the user has permission to view will be returned.

Action Parameters

id
integerRequired
depth
stringDefaults to all
sort
string
status
array
title
string
body__format
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Updates the classification level for a specific whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to edit the whiteboard.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific whiteboard. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the whiteboard and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the children inline comments of specific comment. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns data policy metadata for the workspace. permissions required: only apps can make this request. permission to access the confluence site (‘can use’ global permission).

Action Parameters

Action Response

data
object
successful
boolean
error

Update a space property by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and ‘admin’ permission for the space.

Action Parameters

space__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Returns space permission assignments for a specific space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the space.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Creates a new content property for a comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the comment.

Action Parameters

comment__id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Creates a new custom content in the given space, page, blogpost or other custom content. only one of spaceid, pageid, blogpostid, or customcontentid is required in the request body. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page or blogpost and its corresponding space. permission to create custom content in the space.

Action Parameters

type
stringRequired
status
string
spaceId
string
pageId
string
blogPostId
string
customContentId
string
title
stringRequired
body
objectRequired

Action Response

data
object
successful
boolean
error

Returns the attachments of specific page. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired
sort
string
cursor
string
status
array
mediaType
string
filename
string
limit
integerDefaults to 50

Action Response

data
object
successful
boolean
error

Delete a page by id. by default this will delete pages that are non-drafts. to delete a page that is a draft, the endpoint must be called on a draft with the following param draft=true. discarded drafts are not sent to the trash and are permanently deleted. deleting a page moves the page to the trash, where it can be restored later. to permanently delete a page (or “purge” it), the endpoint must be called on a trashed page with the following param purge=true. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page and its corresponding space. permission to delete pages in the space. permission to administer the space (if attempting to purge).

Action Parameters

id
integerRequired
purge
boolean
draft
boolean

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific folder. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the folder and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Updates the classification level for a specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to edit the page.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Resets the classification level for a specific whiteboard for the space default classification level. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the whiteboard.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a space property by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission) and ‘admin’ permission for the space.

Action Parameters

space__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Returns the labels of specific space. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the space. only labels that the user has permission to view will be returned.

Action Parameters

id
integerRequired
prefix
stringDefaults to my, team
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns user details for the ids provided in the request body. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). the user must be able to view user profiles in the confluence site.

Action Parameters

accountIds
arrayRequired

Action Response

data
object
successful
boolean
error

Creates a space as specified in the payload. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to create spaces.

Action Parameters

name
stringRequired
key
string
alias
string
description__value
string
description__representation
string
roleAssignments__principal__principalType
string
roleAssignments__principal__principalId
string
roleAssignments__roleId
string

Action Response

data
object
successful
boolean
error

Returns the permitted operations on specific custom content. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the parent content of the custom content and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Updates the classification level for a specific database. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to edit the database.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves a specific content property by id that is attached to a specified blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post.

Action Parameters

blogpost__id
integerRequired
property__id
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves the space role by id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns all ancestors for a given database by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as get database by id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission). permission to view the database and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Returns the versions of specific attachment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the attachment and its corresponding space.

Action Parameters

id
stringRequired
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Update a content property for blog post by its id. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to edit the blog post.

Action Parameters

blogpost__id
integerRequired
property__id
integerRequired
key
string
value
version__number
integer
version__message
string

Action Response

data
object
successful
boolean
error

Returns the versions of specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
object
successful
boolean
error

Returns a specific blog post. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the blog post and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
get__draft
boolean
status
array
version
integer
include__labels
boolean
include__properties
boolean
include__operations
boolean
include__likes
boolean
include__versions
boolean
include__version
booleanDefaults to True
include__favorited__by__current__user__status
boolean
include__webresources
boolean
include__collaborators
boolean

Action Response

data
object
successful
boolean
error

Returns a list of classification levels available. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission).

Action Parameters

Action Response

data
object
successful
boolean
error

Searches for users using user-specific queries from the confluence query language (cql).

Action Parameters

cql
stringRequired
start
integer
limit
integerDefaults to 25
expand
array
sitePermissionTypeFilter
stringDefaults to none

Action Response

data
object
successful
boolean
error

Resets the classification level for a specific page for the space default classification level. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and permission to view the page.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Returns the list of emails from the input list that do not have access to site. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to access the confluence site (‘can use’ global permission).

Action Parameters

emails
arrayRequired

Action Response

data
object
successful
boolean
error

Returns the labels of specific blog post. the number of results is limited by the limit parameter and additional results (if available) will be available through the next url present in the link response header. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the content of the blog post and its corresponding space. only labels that the user has permission to view will be returned.

Action Parameters

id
integerRequired
prefix
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Creates a folder in the space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the corresponding space. permission to create a folder in the space.

Action Parameters

spaceId
stringRequired
title
string
parentId
string

Action Response

data
object
successful
boolean
error

Retrieves content properties attached to a specified comment. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the comment.

Action Parameters

comment__id
integerRequired
key
string
sort
string
cursor
string
limit
integerDefaults to 25

Action Response

data
object
successful
boolean
error

Update the default classification level for a specific space. [permissions](https://confluence.atlassian.com/x/ aozkw) required: ‘permission to access the confluence site (‘can use’ global permission) and ‘admin’ permission for the space.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Creates a page in the space. pages are created as published by default unless specified as a draft in the status field. if creating a published page, the title must be specified. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the corresponding space. permission to create a page in the space.

Action Parameters

embedded
boolean
private
boolean
root__level
boolean
spaceId
stringRequired
status
string
title
string
parentId
string
body
object

Action Response

data
object
successful
boolean
error

Creates a new content property for a page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to update the page.

Action Parameters

page__id
integerRequired
key
string
value

Action Response

data
object
successful
boolean
error

Returns a specific page. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to view the page and its corresponding space.

Action Parameters

id
integerRequired
body__format
string
get__draft
boolean
status
array
version
integer
include__labels
boolean
include__properties
boolean
include__operations
boolean
include__likes
boolean
include__versions
boolean
include__version
booleanDefaults to True
include__favorited__by__current__user__status
boolean
include__webresources
boolean
include__collaborators
boolean

Action Response

data
object
successful
boolean
error

Sets space role assignments as specified in the payload. [permissions](https://confluence.atlassian.com/x/ aozkw) required: permission to manage roles in the space.

Action Parameters

id
integerRequired
principal__principalType
string
principal__principalId
string
roleId
string

Action Response

data
object
successful
boolean
error