Confluence Connector v1.0 Initial Release

Version 1

Connector Overview: This page documents all 74 endpoints for the Confluenceconnector v1.

GET

Attachment: Get attachment by id

Returns a specific attachment.

Permissions required:
Permission to view the attachment's container.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content.
`Version`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
`Response Type`	N/A

GET

Attachment: Get attachments for blog post

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 required:
Permission to view the content of the blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post for which attachments should be returned.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Mediatype`	Filters on the mediaType of attachments. Only one may be specified.
`Filename`	Filters on the file-name of attachments. Only one may be specified.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Attachment: Get attachments for custom content

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 required:
Permission to view the content of the custom content and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the custom content for which attachments should be returned.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Mediatype`	Filters on the mediaType of attachments. Only one may be specified.
`Filename`	Filters on the file-name of attachments. Only one may be specified.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Attachment: Get attachments for page

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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page for which attachments should be returned.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Mediatype`	Filters on the mediaType of attachments. Only one may be specified.
`Filename`	Filters on the file-name of attachments. Only one may be specified.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

POST

Blog Post: Create blog post

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Spaceid`	ID of the space
`Status`	The status of the blog post, specifies if the blog post will be created as a new blog post or a draft
`Title`	Title of the blog post, required if creating non-draft.

DELETE

Blog Post: Delete blog post

Delete a blog post by id.

Permissions required:
Permission to view the blog post and its corresponding space. Permission to delete blog posts in the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post to be deleted.
`Response Type`	N/A

GET

Blog Post: Get blog post by id

Returns a specific blog post.

Permissions required:
Permission to view the blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Get-draft`	Retrieve the draft version of this blog post.
`Version`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
`Response Type`	N/A

GET

Blog Post: Get blog posts

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 required:
Permission to access the Confluence site ('Can use' global permission).
Only blog posts that the user has permission to view will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of blog posts per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Blog Post: Get blog posts for label

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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the label for which blog posts should be returned.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of blog posts per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Blog Post: Get blog posts in space

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 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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the space for which blog posts should be returned.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of blog posts per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

PUT

Blog Post: Update blog post

Update a blog post by id.

Permissions required:
Permission to view the blog post and its corresponding space. Permission to update blog posts in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results.
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	Id of the blog post.
`Status`	The status of the blog post.
`Title`	Title of the blog post.
`Spaceid`	ID of the containing space.

GET

Children: Get child custom content

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 required:
Permission to access the Confluence site ('Can use' global permission).
Only custom content that the user has permission to view will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Sort`	Used to sort the result by a particular field.
`Response Type`	N/A

GET

Children: Get child pages

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 required:
Permission to access the Confluence site ('Can use' global permission).
Only pages that the user has permission to view will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Sort`	Used to sort the result by a particular field.
`Response Type`	N/A

POST

Comment: Create footer comment

Create a footer 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).

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Blogpostid`	ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply.
`Pageid`	ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply.
`Parentcommentid`	ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment.

POST

Comment: Create inline comment

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 required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Blogpostid`	ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply.
`Pageid`	ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply.
`Parentcommentid`	ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment.

DELETE

Comment: Delete footer comment

Deletes a footer comment. This is a permanent deletion and cannot be reverted.

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment to be retrieved.
`Response Type`	N/A

DELETE

Comment: Delete inline comment

Deletes an inline comment. This is a permanent deletion and cannot be reverted.

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment to be deleted.
`Response Type`	N/A

GET

Comment: Get children footer comments

Returns the children footer 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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the parent comment for which footer comment children should be returned.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Comment: Get children inline comments

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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the parent comment for which inline comment children should be returned.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Comment: Get footer comment by id

Retrieves a footer comment by id

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment to be retrieved.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Version`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
`Response Type`	N/A

GET

Comment: Get footer comments for blog post

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 required:
Permission to view the content of the blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post for which footer comments should be returned.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Comment: Get footer comments for page

Returns the root footer 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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page for which footer comments should be returned.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Comment: Get inline comment by id

Retrieves an inline comment by id

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment to be retrieved.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Version`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
`Response Type`	N/A

GET

Comment: Get inline comments for blog post

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 required:
Permission to view the content of the blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post for which inline comments should be returned.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of inline comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Comment: Get inline comments for page

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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page for which inline comments should be returned.
`Body-format`	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of inline comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

PUT

Comment: Update footer comment

Update a footer comment. This can be used to update the body text of a comment.

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment to be retrieved.
`Response Type`	N/A

PUT

Comment: Update inline comment

Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment to be retrieved.
`Response Type`	N/A

Options (1)

Option Name	Description
`Resolved`	-\| Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If matching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling comment cannot be updated.

GET

Content Properties: Get content properties for attachment

Retrieves all Content Properties tied to a specified attachment.

Permissions required:
Permission to view the attachment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attachment-id`	The ID of the attachment for which content properties should be returned.
`Key`	Filters the response to return a specific content property with matching key (case sensitive).
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Content Properties: Get content properties for blog post

Retrieves all Content Properties tied to a specified blog post.

Permissions required:
Permission to view the blog post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Blogpost-id`	The ID of the blog post for which content properties should be returned.
`Key`	Filters the response to return a specific content property with matching key (case sensitive).
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Content Properties: Get content properties for comment

Retrieves Content Properties attached to a specified comment.

Permissions required:
Permission to view the comment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment for which content properties should be returned.
`Key`	Filters the response to return a specific content property with matching key (case sensitive).
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Content Properties: Get content properties for custom content

Retrieves Content Properties tied to a specified custom content.

Permissions required:
Permission to view the custom content.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Custom-content-id`	The ID of the custom content for which content properties should be returned.
`Key`	Filters the response to return a specific content property with matching key (case sensitive).
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Content Properties: Get content properties for page

Retrieves Content Properties tied to a specified page.

Permissions required:
Permission to view the page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page-id`	The ID of the page for which content properties should be returned.
`Key`	Filters the response to return a specific content property with matching key (case sensitive).
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Content Properties: Get content property for attachment by id

Retrieves a specific Content Property by ID that is attached to a specified attachment.

Permissions required:
Permission to view the attachment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attachment-id`	The ID of the attachment for which content properties should be returned.
`Property-id`	The ID of the content property to be returned
`Response Type`	N/A

GET

Content Properties: Get content property for blog post by id

Retrieves a specific Content Property by ID that is attached to a specified blog post.

Permissions required:
Permission to view the blog post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Blogpost-id`	The ID of the blog post for which content properties should be returned.
`Property-id`	The ID of the property being requested
`Response Type`	N/A

GET

Content Properties: Get content property for comment by id

Retrieves a specific Content Property by ID that is attached to a specified comment.

Permissions required:
Permission to view the comment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment-id`	The ID of the comment for which content properties should be returned.
`Property-id`	The ID of the content property being requested.
`Response Type`	N/A

GET

Content Properties: Get content property for custom content by id

Retrieves a specific Content Property by ID that is attached to a specified custom content.

Permissions required:
Permission to view the page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Custom-content-id`	The ID of the custom content for which content properties should be returned.
`Property-id`	The ID of the content property being requested.
`Response Type`	N/A

GET

Content Properties: Get content property for page by id

Retrieves a specific Content Property by ID that is attached to a specified page.

Permissions required:
Permission to view the page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page-id`	The ID of the page for which content properties should be returned.
`Property-id`	The ID of the content property being requested.
`Response Type`	N/A

POST

Custom Content: Create custom content

Creates a new custom content in the given space, page, blogpost or other custom conent.

Only one of spaceId, pageId, blogPostId, or customContentId is required in the request body.
Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to create custom content in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Type`	Type of custom content.
`Status`	The status of the custom content
`Spaceid`	ID of the containing space
`Pageid`	ID of the containing page
`Blogpostid`	ID of the containing Blog Post
`Customcontentid`	ID of the containing custom content
`Title`	Title of the custom content

DELETE

Custom Content: Delete custom content

Delete a custom content by id.

Permissions required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to delete custom content in the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the custom content to be deleted.
`Response Type`	N/A

GET

Custom Content: Get custom content by id

Returns a specific piece of custom content.

Permissions required:
Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
`Version`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
`Response Type`	N/A

GET

Custom Content: Get custom content by type

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 required:
Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
`Response Type`	N/A

GET

Custom Content: Get custom content by type in blog post

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 required:
Permission to view the custom content, the container of the custom content (blog post), and the corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post for which custom content should be returned.
`Type`	The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
`Response Type`	N/A

GET

Custom Content: Get custom content by type in page

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 required:
Permission to view the custom content, the container of the custom content (page), and the corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page for which custom content should be returned.
`Type`	The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
`Response Type`	N/A

GET

Custom Content: Get custom content by type in space

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 required:
Permission to view the custom content and the corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the space for which custom content should be returned.
`Type`	The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
`Response Type`	N/A

PUT

Custom Content: Update custom content

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 required:
Permission to view the content of the page or blogpost and its corresponding space. Permission to update custom content in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the custom content to be updated. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.
`Response Type`	N/A

Options (8)

Option Name	Description
`Id`	Id of custom content.
`Type`	Type of custom content.
`Status`	The status of the custom content
`Spaceid`	ID of the containing space
`Pageid`	ID of the containing page
`Blogpostid`	ID of the containing Blog Post
`Customcontentid`	ID of the containing custom content
`Title`	Title of the custom content

GET

Label: Get labels for attachment

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 required:
Permission to view the parent content of the attachment and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the attachment for which labels should be returned.
`Prefix`	Filter the results to labels based on their prefix.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Label: Get labels for blog post

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 required:
Permission to view the content of the blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post for which labels should be returned.
`Prefix`	Filter the results to labels based on their prefix.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Label: Get labels for custom content

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 required:
Permission to view the custom content and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the custom content for which labels should be returned.
`Prefix`	Filter the results to labels based on their prefix.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Label: Get labels for page

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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page for which labels should be returned.
`Prefix`	Filter the results to labels based on their prefix.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

POST

Page: Create page

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 required:
Permission to view the corresponding space. Permission to create a page in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Spaceid`	ID of the space
`Parentid`	ID of the parent page, or null if there is no parent page.
`Status`	The status of the page, published or draft.
`Title`	Title of the page, required if page status is not draft.

DELETE

Page: Delete page

Delete a page by id.

Permissions required:
Permission to view the page and its corresponding space. Permission to delete pages in the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page to be deleted.
`Response Type`	N/A

GET

Page: Get page by id

Returns a specific page.

Permissions required:
Permission to view the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Get-draft`	Retrieve the draft version of this page.
`Version`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
`Response Type`	N/A

GET

Page: Get pages

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 required:
Permission to access the Confluence site ('Can use' global permission).
Only pages that the user has permission to view will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Page: Get pages for label

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 required:
Permission to view the content of the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the label for which pages should be returned.
`Sort`	Used to sort the result by a particular field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Page: Get pages in space

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 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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the space for which pages should be returned.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

PUT

Page: Update page

Update a page by id.

Permissions required:
Permission to view the page and its corresponding space. Permission to update pages in the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results.
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	Id of the page.
`Status`	The status of the page.
`Title`	Title of the page.
`Spaceid`	ID of the containing space.

POST

Space Properties: Create space property in space

Creates a new space property.

Permissions required:
Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Space-id`	The ID of the space for which space properties should be returned.
`Response Type`	N/A

Options (2)

Option Name	Description
`Key`	Key of the space property
`Value`	Value of the space property.

DELETE

Space Properties: Delete space property by id

Deletes a space property by its id.

Permissions required:
Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Space-id`	The ID of the space the property belongs to.
`Property-id`	The ID of the property to be deleted.
`Response Type`	N/A

GET

Space Properties: Get space properties in space

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 required:
Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Space-id`	The ID of the space for which space properties should be returned.
`Key`	The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Space Properties: Get space property by id

Retrieve a space property by its id.

Permissions required:
Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Space-id`	The ID of the space the property belongs to.
`Property-id`	The ID of the property to be retrieved.
`Response Type`	N/A

PUT

Space Properties: Update space property by id

Update a space property by its id.

Permissions required:
Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Space-id`	The ID of the space the property belongs to.
`Property-id`	The ID of the property to be updated.
`Response Type`	N/A

Options (2)

Option Name	Description
`Key`	Key of the space property
`Value`	Value of the space property.

GET

Space: Get space by id

Returns a specific space.

Permissions required:
Permission to view the space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the space to be returned.
`Description-format`	The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.
`Response Type`	N/A

GET

Space: Get spaces

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 required:
Permission to access the Confluence site ('Can use' global permission).
Only spaces that the user has permission to view will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.
`Keys`	Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.
`Type`	Filter the results to spaces based on their type.
`Status`	Filter the results to spaces based on their status.
`Labels`	Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.
`Sort`	Used to sort the result by a particular field.
`Description-format`	The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Task: Get task by id

Returns a specific task.

Permissions required:
Permission to view the containing page or blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results.
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Response Type`	N/A

GET

Task: Get tasks

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 required:
Permission to access the Confluence site ('Can use' global permission).
Only tasks that the user has permission to view will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Body-format`	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
`Include-blank-tasks`	Specifies whether to include blank tasks in the response. Defaults to true.
`Status`	Filters on the status of the task.
`Space-id`	Filters on the space ID of the task. Multiple IDs can be specified.
`Page-id`	Filters on the page ID of the task. Multiple IDs can be specified. Note - passing both page and blog post filters will result in an empty response.
`Blogpost-id`	Filters on the blog post ID of the task. Multiple IDs can be specified. Note - passing both page and blog post filters will result in an empty response.
`Created-by`	Filters on the Account ID of the user who created this task. Multiple IDs can be specified.
`Assigned-to`	Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.
`Completed-by`	Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.
`Created-at-from`	Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
`Created-at-to`	Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
`Due-at-from`	Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
`Due-at-to`	Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
`Completed-at-from`	Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
`Completed-at-to`	Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Response Type`	N/A

GET

Version: Get attachment versions

Returns the versions of specific attachment.

Permissions required:
Permission to view the attachment and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Sort`	Used to sort the result by a particular field.
`Response Type`	N/A

GET

Version: Get blog post versions

Returns the versions of specific blog post.

Permissions required:
Permission to view the blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the blog post to be queried for its versions. If you don't know the blog post ID, use Get blog posts and filter the results.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Sort`	Used to sort the result by a particular field.
`Response Type`	N/A

GET

Version: Get custom content versions

Returns the versions of specific custom content.

Permissions required:
Permission to view the custom content and its corresponding page and space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Custom-content-id`	The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Sort`	Used to sort the result by a particular field.
`Response Type`	N/A

GET

Version: Get page versions

Returns the versions of specific page.

Permissions required:
Permission to view the page and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results.
`Cursor`	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
`Limit`	Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
`Sort`	Used to sort the result by a particular field.
`Response Type`	N/A

GET

Version: Get version details for attachment version

Retrieves version details for the specified attachment and version number.

Permissions required:
Permission to view the attachment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attachment-id`	The ID of the attachment for which version details should be returned.
`Version-number`	The version number of the attachment to be returned.
`Response Type`	N/A

GET

Version: Get version details for blog post version

Retrieves version details for the specified blog post and version number.

Permissions required:
Permission to view the blog post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Blogpost-id`	The ID of the blog post for which version details should be returned.
`Version-number`	The version number of the blog post to be returned.
`Response Type`	N/A

GET

Version: Get version details for custom content version

Retrieves version details for the specified custom content and version number.

Permissions required:
Permission to view the page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Custom-content-id`	The ID of the custom content for which version details should be returned.
`Version-number`	The version number of the custom content to be returned.
`Response Type`	N/A

GET

Version: Get version details for footer comment version

Retrieves version details for the specified footer comment version.

Permissions required:
Permission to view the content of the page or blog post and its corresponding space.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the footer comment for which version details should be returned.
`Version-number`	The version number of the footer comment to be returned.
`Response Type`	N/A

GET

Version: Get version details for page version

Retrieves version details for the specified page and version number.

Permissions required:
Permission to view the page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page-id`	The ID of the page for which version details should be returned.
`Version-number`	The version number of the page to be returned.
`Response Type`	N/A