The account ID of the user who created this page originally.

Type of content representation used for the value field.

Body of the content, in the format found in the representation field.

Date and time when the page was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

The account ID of the user who owned this page previously, or null if there is no previous owner.

The account ID of the user who owns this page.

ID of the parent page, or null if there is no parent page.

Content type of the parent, or null if there is no parent.

Position of child page within the given parent page tree.

The account ID of the user who created this version.

Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

Message associated with the current version.

Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.

Pages

ID of the containing blog post.

Note: This is only returned if the attachment has a container that is a blog post.

Date and time when the attachment was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

ID of the containing custom content.

Note: This is only returned if the attachment has a container that is custom content.

File ID of the attachment. This is the ID referenced in `atlas_doc_format` bodies and is distinct from the attachment ID.

Media Type description for the attachment.

ID of the containing page.

Note: This is only returned if the attachment has a container that is a page.

Attachments

The account ID of the user who created this blog post originally.

Contains fields for each representation type requested.

Date and time when the blog post was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

Output schema

Blogposts

Content Items

Confluence

Get markdown content of a Page or Blog using its globalId

Get Markdown from Page or Blog

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.

Get attachments

Returns a specific attachment.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the attachment's container.

Get attachment by id

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

Delete 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the parent content of the attachment and its corresponding space.

Get labels for attachment

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.

Get permitted operations for attachment

Retrieves all Content Properties tied to a specified attachment.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the attachment.

Get content properties for attachment

Creates a new content property for an attachment.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to update the attachment.

Create content property for attachment

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.

Get content property for attachment by id

Update a content property for attachment by its id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the attachment.

Update content property for attachment by id

Deletes a content property for an attachment by its id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to attachment the page.

Delete content property for attachment by id

Returns the versions of specific attachment.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the attachment and its corresponding space.

Get attachment versions

Retrieves version details for the specified attachment and version number.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the attachment.

Get version details for attachment version

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.

Get attachment comments

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.

Get blog posts

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

Create blog post

Returns a specific blog post.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the blog post and its corresponding space.

Get blog post by id

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.

Update blog post

Delete a blog post by id.

Deleting a blog post 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).

Delete 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the blog post and its corresponding space.

Get attachments for 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](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.

Get custom content by type in 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the blog post and its corresponding space.

Get labels for blog post

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.

Get like count for blog post

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.

Get account IDs of likes for blog post

Retrieves all Content Properties tied to a specified blog post.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the blog post.

Get content properties for blog post

Creates a new property for a blogpost.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to update the blog post.

Create content property for blog post

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.

Get content property for blog post by id

Update a content property for blog post by its id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the blog post.

Update content property for blog post by id

Deletes a content property for a blogpost by its id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the blog post.

Delete content property for blogpost by id

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.

Get permitted operations for blog post

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.

Get blog post versions

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.

Get version details for blog post version

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.

Convert content ids to content types

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

Get custom content by type

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.

Create custom content

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

Get custom content by id

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.

Update custom content

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

Delete 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the custom content and its corresponding space.

Get attachments for custom content

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.

Get custom content comments

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.

Get labels for custom content

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.

Get permitted operations for custom content

Retrieves Content Properties tied to a specified custom content.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the custom content.

Get content properties for custom content

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.

Create content property for custom content

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.

Get content property for custom content by id

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.

Update content property for custom content by id

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.

Delete content property for custom content by id

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.

Get labels

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.

Get attachments 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

Get blog posts 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

Get pages for label

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.

Get pages

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.

Create page

Returns a specific page.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the page and its corresponding space.

Get page by id

Update a page by id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the page and its corresponding space. Permission to update pages in the space.

Update page

Delete a page by id.

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

Delete 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

Get attachments for 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the custom content, the container of the custom content (page), and the corresponding space.

Get custom content by type in 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

Get labels for page

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.

Get like count for page

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.

Get account IDs of likes for page

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.

Get permitted operations for page

Retrieves Content Properties tied to a specified page.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the page.

Get content properties for page

Creates a new content property for a page.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to update the page.

Create content property for page

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.

Get content property for page by id

Update a content property for a page by its id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the page.

Update content property for page by id

Deletes a content property for a page by its id.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the page.

Delete content property for page by id

Returns the versions of specific page.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the page and its corresponding space.

Get page versions

Retrieves version details for the specified page and version number.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the page.

Get version details for page version

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.

Get custom content versions

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

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the page.

Get version details for custom content version

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.

Get spaces

Returns a specific space.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the space.

Get space by id

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.

Get blog posts in space

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.

Get labels for space

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.

Get labels for space content

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.

Get custom content by type in space

Returns the permitted operations on specific space.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the corresponding space.

Get permitted operations for 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](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.

Get pages 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space.

Get space properties in space

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.

Create space property in space

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.

Get space property by id

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.

Update space property by id

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.

Delete space property by id

Returns space permissions for a specific space.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the space.

Get space permissions

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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

Get footer 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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

Field Name	API Key	Type	Description
Id	id	string	The unique identifier of the page
Status	status	string	The status of the content.
Title	title	string	Title of the page.
Space Id	spaceId	string	ID of the space the page is in.
Parent Id	parentId

Confluence API Integration Profile

How to work with Pages in Confluence API

Operations on Pages Collection

Build every single integration your customers need with AI