Skip to content
Changelog

Report a bug

Confluence integration: operations for AI agents

Confluence connects to Type.com as an integration. This page lists the 377 operations documented for Claude and Codex in Type.com: 211 read, 64 write, 102 destructive.

About Confluence

A tool for team collaboration and knowledge management.

Categories: Productivity & Project Management

How to connect Confluence to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

377 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

377 operations listed.

Content Permissions

  • Read

    Get page restriction state

    Returns the restriction state of a page. Permissions required: Permission to view the page.

  • Read

    Get blog post restriction state

    Returns the restriction state of a blog post. Permissions required: Permission to view the blog post.

  • Read

    Get database restriction state

    Returns the restriction state of a database. Permissions required: Permission to view the database.

  • Read

    Get whiteboard restriction state

    Returns the restriction state of a whiteboard. Permissions required: Permission to view the whiteboard.

  • Read

    Get folder restriction state

    Returns the restriction state of a folder. Permissions required: Permission to view the folder.

  • Read

    Get page permissions

    Returns the direct content permissions on a page with optional filtering by operation, principal-type, and principal-id. Results are cursor-paginated (max 250 per page). Permissions required: Permission to view the page.

  • Read

    Get blog post permissions

    Returns the direct content permissions on a blog post with optional filtering by operation, principal-type, and principal-id. Results are cursor-paginated (max 250 per page). Permissions required: Permission to view the blog post.

  • Read

    Get database permissions

    Returns the direct content permissions on a database with optional filtering. Results are cursor-paginated (max 250 per page). Permissions required: Permission to view the database.

  • Read

    Get whiteboard permissions

    Returns the direct content permissions on a whiteboard with optional filtering. Results are cursor-paginated (max 250 per page). Permissions required: Permission to view the whiteboard.

  • Read

    Get folder permissions

    Returns the direct content permissions on a folder with optional filtering. Results are cursor-paginated (max 250 per page). Permissions required: Permission to view the folder.

  • Write

    Add page permissions

    Adds or replaces direct content permissions for the specified principals on a page. Permissions for other principals are preserved; use PUT to replace all permissions at once. A principal can hold only one read or update permission.

  • Write

    Add blog post permissions

    Adds or replaces direct content permissions for the specified principals on a blog post. Permissions for other principals are preserved; use PUT to replace all permissions at once. A principal can hold only one read or update permission.

  • Write

    Add database permissions

    Adds or replaces direct content permissions for the specified principals on a database. Permissions for other principals are preserved; use PUT to replace all permissions at once. A principal can hold only one read or update permission.

  • Write

    Add whiteboard permissions

    Adds or replaces direct content permissions for the specified principals on a whiteboard. Permissions for other principals are preserved; use PUT to replace all permissions at once. A principal can hold only one read or update permission.

  • Write

    Add folder permissions

    Adds or replaces direct content permissions for the specified principals on a folder. Permissions for other principals are preserved; use PUT to replace all permissions at once. A principal can hold only one read or update permission.

  • Destructive

    Set page restriction state

    Sets the restriction state of a page. Permissions required: Permission to edit the page or administer the space.

  • Destructive

    Set blog post restriction state

    Sets the restriction state of a blog post. Permissions required: Permission to edit the blog post or administer the space.

  • Destructive

    Set database restriction state

    Sets the restriction state of a database. Permissions required: Permission to edit the database or administer the space.

  • Destructive

    Set whiteboard restriction state

    Sets the restriction state of a whiteboard. Permissions required: Permission to edit the whiteboard or administer the space.

  • Destructive

    Set folder restriction state

    Sets the restriction state of a folder. Permissions required: Permission to edit the folder or administer the space.

  • Destructive

    Set page permissions

    Replaces all direct content permissions on a page with the provided set. Any permissions not included in the request body are removed. Permissions required: Permission to edit the page or administer the space.

  • Destructive

    Delete page permissions

    Deletes direct content permissions from a page. Filters narrow the deletion scope; omitting all filters deletes all direct permissions. The following filter combinations are supported: - No filters: deletes all direct permissions.

  • Destructive

    Set blog post permissions

    Replaces all direct content permissions on a blog post with the provided set. Any permissions not included in the request body are removed. Permissions required: Permission to edit the blog post or administer the space.

  • Destructive

    Delete blog post permissions

    Deletes direct content permissions from a blog post. See DELETE /pages/{id}/permissions for filter semantics. Permissions required: Permission to edit the blog post or administer the space.

  • Destructive

    Set database permissions

    Replaces all direct content permissions on a database with the provided set. Permissions required: Permission to edit the database or administer the space.

  • Destructive

    Delete database permissions

    Deletes direct content permissions from a database. See DELETE /pages/{id}/permissions for filter semantics. Permissions required: Permission to edit the database or administer the space.

  • Destructive

    Set whiteboard permissions

    Replaces all direct content permissions on a whiteboard with the provided set. Permissions required: Permission to edit the whiteboard or administer the space.

  • Destructive

    Delete whiteboard permissions

    Deletes direct content permissions from a whiteboard. See DELETE /pages/{id}/permissions for filter semantics. Permissions required: Permission to edit the whiteboard or administer the space.

  • Destructive

    Set folder permissions

    Replaces all direct content permissions on a folder with the provided set. Permissions required: Permission to edit the folder or administer the space.

  • Destructive

    Delete folder permissions

    Deletes direct content permissions from a folder. See DELETE /pages/{id}/permissions for filter semantics. Permissions required: Permission to edit the folder or administer the space.

Admin Key

  • Read

    Get Admin Key

    Returns information about the admin key if one is currently enabled for the calling user within the site. Permissions required: User must be an organization or site admin.

  • Write

    Enable Admin Key

    Enables admin key access for the calling user within the site. If an admin key already exists for the user, a new one will be issued with an updated expiration time. Note: The durationInMinutes field within the request body is optional.

  • Destructive

    Disable Admin Key

    Disables admin key access for the calling user within the site. Permissions required: User must be an organization or site admin.

Attachment

  • Read

    Get attachments

    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 required: Permission to view the container of the attachment.

  • Read

    Get attachment by id

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

  • Read

    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.

  • Read

    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.

  • Read

    Get attachments for label

    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.

  • Read

    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.

  • Read

    Download attachment thumbnail by id

    Redirects the client to a URL that serves an attachment thumbnail's binary data. Permissions required: Permission to view the attachment's container.

  • Destructive

    Delete attachment

    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.

Label

  • Read

    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.

  • Read

    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.

  • Read

    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.

  • Read

    Get labels

    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.

  • Read

    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.

  • Read

    Get labels for 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 required: Permission to view the space.

  • Read

    Get labels for space content

    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.

Operation

  • Read

    Get permitted operations for attachment

    Returns the permitted operations on specific attachment. Permissions required: Permission to view the parent content of the attachment and its corresponding space.

  • Read

    Get permitted operations for blog post

    Returns the permitted operations on specific blog post. Permissions required: Permission to view the parent content of the blog post and its corresponding space.

  • Read

    Get permitted operations for custom content

    Returns the permitted operations on specific custom content. Permissions required: Permission to view the parent content of the custom content and its corresponding space.

  • Read

    Get permitted operations for page

    Returns the permitted operations on specific page. Permissions required: Permission to view the parent content of the page and its corresponding space.

  • Read

    Get permitted operations for a whiteboard

    Returns the permitted operations on specific whiteboard. Permissions required: Permission to view the whiteboard and its corresponding space.

  • Read

    Get permitted operations for a database

    Returns the permitted operations on specific database. Permissions required: Permission to view the database and its corresponding space.

  • Read

    Get permitted operations for a Smart Link in the content tree

    Returns the permitted operations on specific Smart Link in the content tree. Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.

  • Read

    Get permitted operations for a folder

    Returns the permitted operations on specific folder. Permissions required: Permission to view the folder and its corresponding space.

  • Read

    Get permitted operations for space

    Returns the permitted operations on specific space. Permissions required: Permission to view the corresponding space.

  • Read

    Get permitted operations for footer comment

    Returns the permitted operations on specific footer comment. Permissions required: Permission to view the parent content of the footer comment and its corresponding space.

  • Read

    Get permitted operations for inline comment

    Returns the permitted operations on specific inline comment. Permissions required: Permission to view the parent content of the inline comment and its corresponding space.

Content Properties

  • Read

    Get content properties for attachment

    Retrieves all Content Properties tied to a specified attachment. Permissions required: Permission to view the attachment.

  • Read

    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.

  • Read

    Get content properties for blog post

    Retrieves all Content Properties tied to a specified blog post. Permissions required: Permission to view the blog post.

  • Read

    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.

  • Read

    Get content properties for custom content

    Retrieves Content Properties tied to a specified custom content. Permissions required: Permission to view the custom content.

  • Read

    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.

  • Read

    Get content properties for page

    Retrieves Content Properties tied to a specified page. Permissions required: Permission to view the page.

  • Read

    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.

  • Read

    Get content properties for whiteboard

    Retrieves Content Properties tied to a specified whiteboard. Permissions required: Permission to view the whiteboard.

  • Read

    Get content property for whiteboard by id

    Retrieves a specific Content Property by ID that is attached to a specified whiteboard. Permissions required: Permission to view the whiteboard.

  • Read

    Get content properties for database

    Retrieves Content Properties tied to a specified database. Permissions required: Permission to view the database.

  • Read

    Get content property for database by id

    Retrieves a specific Content Property by ID that is attached to a specified database. Permissions required: Permission to view the database.

  • Read

    Get content properties for Smart Link in the content tree

    Retrieves Content Properties tied to a specified Smart Link in the content tree. Permissions required: Permission to view the Smart Link in the content tree.

  • Read

    Get content property for Smart Link in the content tree by id

    Retrieves a specific Content Property by ID that is attached to a specified Smart Link in the content tree. Permissions required: Permission to view the Smart Link in the content tree.

  • Read

    Get content properties for folder

    Retrieves Content Properties tied to a specified folder. Permissions required: Permission to view the folder.

  • Read

    Get content property for folder by id

    Retrieves a specific Content Property by ID that is attached to a specified folder. Permissions required: Permission to view the folder.

  • Read

    Get content properties for comment

    Retrieves Content Properties attached to a specified comment. Permissions required: Permission to view the comment.

  • Read

    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.

  • Write

    Create content property for attachment

    Creates a new content property for an attachment. Permissions required: Permission to update the attachment.

  • Write

    Create content property for blog post

    Creates a new property for a blogpost. Permissions required: Permission to update the blog post.

  • Write

    Create content property for custom content

    Creates a new content property for a piece of custom content. Permissions required: Permission to update the custom content.

  • Write

    Create content property for page

    Creates a new content property for a page. Permissions required: Permission to update the page.

  • Write

    Create content property for whiteboard

    Creates a new content property for a whiteboard. Permissions required: Permission to update the whiteboard.

  • Write

    Create content property for database

    Creates a new content property for a database. Permissions required: Permission to update the database.

  • Write

    Create content property for Smart Link in the content tree

    Creates a new content property for a Smart Link in the content tree. Permissions required: Permission to update the Smart Link in the content tree.

  • Write

    Create content property for folder

    Creates a new content property for a folder. Permissions required: Permission to update the folder.

  • Write

    Create content property for comment

    Creates a new content property for a comment. Permissions required: Permission to update the comment.

  • Destructive

    Update content property for attachment by id

    Update a content property for attachment by its id. Permissions required: Permission to edit the attachment.

  • Destructive

    Delete content property for attachment by id

    Deletes a content property for an attachment by its id. Permissions required: Permission to attachment the page.

  • Destructive

    Update content property for blog post by id

    Update a content property for blog post by its id. Permissions required: Permission to edit the blog post.

  • Destructive

    Delete content property for blogpost by id

    Deletes a content property for a blogpost by its id. Permissions required: Permission to edit the blog post.

  • Destructive

    Update content property for custom content by id

    Update a content property for a piece of custom content by its id. Permissions required: Permission to edit the custom content.

  • Destructive

    Delete content property for custom content by id

    Deletes a content property for a piece of custom content by its id. Permissions required: Permission to edit the custom content.

  • Destructive

    Update content property for page by id

    Update a content property for a page by its id. Permissions required: Permission to edit the page.

  • Destructive

    Delete content property for page by id

    Deletes a content property for a page by its id. Permissions required: Permission to edit the page.

  • Destructive

    Update content property for whiteboard by id

    Update a content property for a whiteboard by its id. Permissions required: Permission to edit the whiteboard.

  • Destructive

    Delete content property for whiteboard by id

    Deletes a content property for a whiteboard by its id. Permissions required: Permission to edit the whiteboard.

  • Destructive

    Update content property for database by id

    Update a content property for a database by its id. Permissions required: Permission to edit the database.

  • Destructive

    Delete content property for database by id

    Deletes a content property for a database by its id. Permissions required: Permission to edit the database.

  • Destructive

    Update content property for Smart Link in the content tree by id

    Update a content property for a Smart Link in the content tree by its id. Permissions required: Permission to edit the Smart Link in the content tree.

  • Destructive

    Delete content property for Smart Link in the content tree by id

    Deletes a content property for a Smart Link in the content tree by its id. Permissions required: Permission to edit the Smart Link in the content tree.

  • Destructive

    Update content property for folder by id

    Update a content property for a folder by its id. Permissions required: Permission to edit the folder.

  • Destructive

    Delete content property for folder by id

    Deletes a content property for a folder by its id. Permissions required: Permission to edit the folder.

  • Destructive

    Update content property for comment by id

    Update a content property for a comment by its id. Permissions required: Permission to edit the comment.

  • Destructive

    Delete content property for comment by id

    Deletes a content property for a comment by its id. Permissions required: Permission to edit the comment.

Version

  • Read

    Get attachment versions

    Returns the versions of specific attachment. Permissions required: Permission to view the attachment and its corresponding space.

  • Read

    Get version details for attachment version

    Retrieves version details for the specified attachment and version number. Permissions required: Permission to view the attachment.

  • Read

    Get blog post versions

    Returns the versions of specific blog post. Permissions required: Permission to view the blog post and its corresponding space.

  • Read

    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.

  • Read

    Get page versions

    Returns the versions of specific page. Permissions required: Permission to view the page and its corresponding space.

  • Read

    Get version details for page version

    Retrieves version details for the specified page and version number. Permissions required: Permission to view the page.

  • Read

    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.

  • Read

    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.

  • Read

    Get footer comment versions

    Retrieves the versions of the specified footer comment. Permissions required: Permission to view the content of the page or blog post and its corresponding space.

  • Read

    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.

  • Read

    Get inline comment versions

    Retrieves the versions of the specified inline comment. Permissions required: Permission to view the content of the page or blog post and its corresponding space.

  • Read

    Get version details for inline comment version

    Retrieves version details for the specified inline comment version. Permissions required: Permission to view the content of the page or blog post and its corresponding space.

Comment

  • Read

    Get attachment comments

    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.

  • Read

    Get custom content comments

    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.

  • Read

    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.

  • Read

    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.

  • Read

    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.

  • Read

    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.

  • Read

    Get footer comments

    Returns all footer comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

  • Read

    Get footer comment by id

    Retrieves a footer comment by id Permissions required: Permission to view the content of the container and its corresponding space.

  • Read

    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.

  • Read

    Get inline comments

    Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

  • Read

    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.

  • Read

    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.

  • Write

    Create footer comment

    Create a footer comment. The footer comment can be made against several locations: - at the top level (specifying pageId or blogPostId in the request body) - as a reply (specifying parentCommentId in the request body) - against an attachment (note: this is different than the com…

  • Write

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

  • Destructive

    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.

  • Destructive

    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.

  • Destructive

    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.

  • Destructive

    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.

Blog Post

  • Read

    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.

  • Read

    Get blog post by id

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

  • Read

    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.

  • Read

    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.

  • Write

    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.

  • Destructive

    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.

  • Destructive

    Delete blog post

    Delete a blog post by id. By default this will delete blog posts that are non-drafts. To delete a blog post that is a draft, the endpoint must be called on a draft with the following param draft=true. Discarded drafts are not sent to the trash and are permanently deleted.

Custom Content

  • Read

    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.

  • Read

    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.

  • Read

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

  • Read

    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.

  • Read

    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.

  • Write

    Create custom content

    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.

  • Destructive

    Update custom content

    Update a custom content by id. At most one of spaceId, pageId, blogPostId, or customContentId is allowed in the request body.

  • Destructive

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

Like

  • Read

    Get like count for blog post

    Returns the count of likes of specific blog post. Permissions required: Permission to view the content of the blog post and its corresponding space.

  • Read

    Get account IDs of likes for blog post

    Returns the account IDs of likes of specific blog post. Permissions required: Permission to view the content of the blog post and its corresponding space.

  • Read

    Get like count for page

    Returns the count of likes of specific page. Permissions required: Permission to view the content of the page and its corresponding space.

  • Read

    Get account IDs of likes for page

    Returns the account IDs of likes of specific page. Permissions required: Permission to view the content of the page and its corresponding space.

  • Read

    Get like count for footer comment

    Returns the count of likes of specific footer comment. Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

  • Read

    Get account IDs of likes for footer comment

    Returns the account IDs of likes of specific footer comment. Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

  • Read

    Get like count for inline comment

    Returns the count of likes of specific inline comment. Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

  • Read

    Get account IDs of likes for inline comment

    Returns the account IDs of likes of specific inline comment. Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

Content

  • Read

    Search content by CQL

    Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see: Advanced searching using CQL. Example initial call: /wiki/rest/api/content/search?cql=type=page&limit=25 Example response: { "results": [ { ... }, { ... }, ... { ...

  • Write

    Convert content ids to content types

    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.

  • Write

    Publish legacy draft

    Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of shared drafts. For now, this method works the same as Publish shared draft.

  • Destructive

    Archive pages

    Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/ REST API to get the copy task status.

  • Destructive

    Publish shared draft

    Publishes a shared draft of a page created from a blueprint. By default, the following objects are expanded: body.storage, history, space, version, ancestors.

Page

  • Read

    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.

  • Read

    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.

  • Read

    Get page by id

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

  • Read

    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.

  • Write

    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.

  • Destructive

    Update page

    Update a page by id. When the "current" version is updated, the provided body content is considered as the latest version. This latest body content will be attempted to be merged into the draft version through a content reconciliation algorithm.

  • Destructive

    Delete page

    Delete a page by id. By default this will delete pages that are non-drafts. To delete a page that is a draft, the endpoint must be called on a draft with the following param draft=true. Discarded drafts are not sent to the trash and are permanently deleted.

  • Destructive

    Update page title

    Updates the title of a specified page. Permissions required: Permission to view the page and its corresponding space. Permission to update pages in the space.

Redactions

  • Write

    Redact Content in a Confluence Page

    Redacts sensitive content in a Confluence page by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration (except code block redactions).

  • Write

    Redact Content in a Confluence Blog Post

    Redacts sensitive content in a Confluence blog post by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration (except code block redactions).

Whiteboard

  • Read

    Get whiteboard by id

    Returns a specific whiteboard. Permissions required: Permission to view the whiteboard and its corresponding space.

  • Write

    Create whiteboard

    Creates a whiteboard in the space. Permissions required: Permission to view the corresponding space. Permission to create a whiteboard in the space.

  • Destructive

    Delete whiteboard

    Delete a whiteboard by id. Deleting a whiteboard moves the whiteboard to the trash, where it can be restored later Permissions required: Permission to view the whiteboard and its corresponding space. Permission to delete whiteboards in the space.

Children

  • Read

    Get direct children of a whiteboard

    Returns all children for given whiteboard id in the content tree. 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.

  • Read

    Get direct children of a database

    Returns all children for given database id in the content tree. 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.

  • Read

    Get direct children of a Smart Link

    Returns all children for given smart link id in the content tree. 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.

  • Read

    Get direct children of a folder

    Returns all children for given folder id in the content tree. 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.

  • Read

    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.

  • Read

    Get direct children of a page

    Returns all children for given page id in the content tree. 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.

Descendants

  • Read

    Get descendants of a whiteboard

    Returns descendants in the content tree for a given whiteboard by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload).

  • Read

    Get descendants of a database

    Returns descendants in the content tree for a given database by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload).

  • Read

    Get descendants of a smart link

    Returns descendants in the content tree for a given smart link by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload).

  • Read

    Get descendants of folder

    Returns descendants in the content tree for a given folder by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload).

  • Read

    Get descendants of page

    Returns descendants in the content tree for a given page by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload).

Ancestors

  • Read

    Get all ancestors of whiteboard

    Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload).

  • Read

    Get all ancestors of database

    Returns all ancestors for a given database by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload).

  • Read

    Get all ancestors of Smart Link in content tree

    Returns all ancestors for a given Smart Link in the content tree by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload).

  • Read

    Get all ancestors of folder

    Returns all ancestors for a given folder by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload).

  • Read

    Get all ancestors of page

    Returns all ancestors for a given page by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload).

Database

  • Read

    Get database by id

    Returns a specific database. Permissions required: Permission to view the database and its corresponding space.

  • Read

    Get fields for database

    Returns the field definitions (schema) for a database, ordered by the user-defined column order, using cursor-based pagination. Consistency: Responses may not immediately reflect recent changes. Clients requiring read-after-write confirmation should poll with bounded backoff.

  • Read

    Get views for database

    Returns the views defined on a database using cursor-based pagination. Only view IDs, names, and types are returned; view configuration is not exposed. Consistency: Responses may not immediately reflect recent changes.

  • Read

    Get entries for database

    Returns the entries (rows) of a database, with optional filtering, sorting, and cursor-based pagination. Entry values are keyed by field ID; use Get fields for database (GET /databases/{id}/fields) to map field IDs to names.

  • Read

    Get entry by id

    Returns a single entry (row) from a database by ID. Consistency: Responses may not immediately reflect recent changes. Clients requiring read-after-write confirmation should poll with bounded backoff.

  • Write

    Create database

    Creates a database in the space. Permissions required: Permission to view the corresponding space. Permission to create a database in the space.

  • Destructive

    Delete database

    Delete a database by id. Deleting a database moves the database to the trash, where it can be restored later Permissions required: Permission to view the database and its corresponding space. Permission to delete databases in the space.

Smart Link

  • Read

    Get Smart Link in the content tree by id

    Returns a specific Smart Link in the content tree. Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.

Folder

  • Read

    Get folder by id

    Returns a specific folder. Permissions required: Permission to view the folder and its corresponding space.

  • Write

    Create folder

    Creates a folder in the space. Permissions required: Permission to view the corresponding space. Permission to create a folder in the space.

  • Destructive

    Delete folder

    Delete a folder by id. Deleting a folder moves the folder to the trash, where it can be restored later Permissions required: Permission to view the folder and its corresponding space. Permission to delete folders in the space.

Space

  • Read

    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.

  • Read

    Get space by id

    Returns a specific space. Permissions required: Permission to view the space.

  • Write

    Create space

    Creates a new space. Note, currently you cannot set space labels when creating a space. Permissions required: 'Create Space(s)' global permission.

  • Write

    Create private space

    Creates a new space that is only visible to the creator. This method is the same as the Create space method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space. Permissions required: 'Create Space(s)' global permission.

  • Destructive

    Update space

    Updates the name, description, or homepage of a space. - For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead. - Currently you cannot set space labels when updating a space.

  • Destructive

    Delete space

    Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned.

Space Properties

  • Read

    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.

  • Read

    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.

  • Write

    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.

  • Destructive

    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.

  • Destructive

    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.

Space Permissions

  • Read

    Get space permissions assignments

    Returns space permission assignments for a specific space. Permissions required: Permission to view the space.

  • Read

    Get available space permissions

    Retrieves the available space permissions. Available on tenants with Role-Based Access Control. Permissions required: Permission to access the Confluence site.

Space Permission Transition

  • Read

    List unassigned space permission combinations

    Lists the unique unassigned space permission combinations currently present on the tenant. Combinations that already map to a space role are filtered out server-side.

  • Read

    Get space permission transition task status

    Retrieves the status of an async space permission transition task. Use the taskId returned from the generate-combinations, assign-roles, or remove-access endpoints to poll for progress and completion. Permissions required: User must be a Confluence administrator.

  • Write

    Generate space permission combinations

    Submits a task to refresh the space permission combinations in the database, which identifies all unique permission combinations across the site. This provides permission combination IDs that can be used with the assign-roles and remove-access endpoints.

  • Write

    Bulk assign space permission roles

    Bulk assigns roles for one or more permission combination IDs obtained from the space permission combinations. Supports targeting all spaces, specific spaces, or excluding specific spaces. Permissions required: User must be a Confluence administrator.

  • Write

    Bulk remove space permission access

    Bulk removes access for one or more permission combination IDs obtained from the space permission combinations. This removes all space permissions for the specified combinations across the targeted spaces. Permissions required: User must be a Confluence administrator.

Space Roles

  • Read

    Get available space roles

    Retrieves the available space roles. Available on tenants with Role-Based Access Control. Permissions required: Permission to access the Confluence site; if requesting a certain space's roles, permission to view the space.

  • Read

    Get space role by ID

    Retrieves the space role by ID. Available on tenants with Role-Based Access Control. Permissions required: Permission to access the Confluence site.

  • Read

    Get space role mode

    Retrieves the space role mode. Available on tenants with Role-Based Access Control. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get space role assignments

    Retrieves the space role assignments. Available on tenants with Role-Based Access Control. Permissions required: Permission to view the space.

  • Write

    Create a space role

    Create a space role. Available on tenants with Role-Based Access Control. Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.

  • Write

    Set space role assignments

    Sets space role assignments as specified in the payload. For each entry, if roleId is provided the principal is assigned to that role. If roleId is omitted, the role assignment for that principal is removed, if it exists. Available on tenants with Role-Based Access Control.

  • Destructive

    Update a space role

    Update a space role. Available on tenants with Role-Based Access Control. Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.

  • Destructive

    Delete a space role

    Delete a space role Available on tenants with Role-Based Access Control. Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.

Long running task

  • Read

    Get long-running tasks

    Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get long-running task

    Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed. Permissions required: Permission to access the Confluence site ('Can use' global permission).

Task

  • Read

    Get task by id

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

  • Destructive

    Update task

    Update a task by id. This endpoint currently only supports updating task status. Permissions required: Permission to edit the containing page or blog post and view its corresponding space.

User

  • Read

    Check site access for a list of emails

    Returns the list of emails from the input list that do not have access to site. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Write

    Create bulk user lookup using ids

    Returns user details for the ids provided in the request body. Permissions required: Permission to access the Confluence site ('Can use' global permission). The user must be able to view user profiles in the Confluence site.

  • Write

    Invite a list of emails to the site

    Invite a list of emails to the site. Ignores all invalid emails and no action is taken for the emails that already have access to the site. NOTE: This API is asynchronous and may take some time to complete.

Data Policies

  • Read

    Get data policy metadata for the workspace

    Returns data policy metadata for the workspace. Permissions required: Only apps can make this request. Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get spaces with data policies

    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.

Classification Level

  • Read

    Get list of classification levels

    Returns a list of classification levels available. Permissions required: 'Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get space default classification level

    Returns the default classification level for a specific space. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the space.

  • Read

    Get page classification level

    Returns the classification level for a specific page. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the page. 'Permission to edit the page is required if trying to view classification level for a draft.

  • Read

    Get blog post classification level

    Returns the classification level for a specific blog post. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the blog post.

  • Read

    Get whiteboard classification level

    Returns the classification level for a specific whiteboard. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.

  • Read

    Get database classification level

    Returns the classification level for a specific database. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.

  • Write

    Reset page classification level

    Resets the classification level for a specific page for the space default classification level. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the page.

  • Write

    Reset blog post classification level

    Resets the classification level for a specific blog post for the space default classification level. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the blog post.

  • Write

    Reset whiteboard classification level

    Resets the classification level for a specific whiteboard for the space default classification level. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.

  • Write

    Reset database classification level

    Resets the classification level for a specific database for the space default classification level. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.

  • Destructive

    Update space default classification level

    Update the default classification level for a specific space. Permissions required: Permission to access the Confluence site ('Can use' global permission) and manage/space permission for the space.

  • Destructive

    Delete space default classification level

    Returns the default classification level for a specific space. Permissions required: Permission to access the Confluence site ('Can use' global permission) and manage/space permission for the space.

  • Destructive

    Update page classification level

    Updates the classification level for a specific page. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the page.

  • Destructive

    Update blog post classification level

    Updates the classification level for a specific blog post. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the blog post.

  • Destructive

    Update whiteboard classification level

    Updates the classification level for a specific whiteboard. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the whiteboard.

  • Destructive

    Update database classification level

    Updates the classification level for a specific database. Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the database.

App Properties

  • Read

    Get Forge app properties.

    Gets Forge app properties. This API can only be accessed using asApp() requests from Forge.

  • Read

    Get a Forge app property by key.

    Gets a Forge app property by property key. This API can only be accessed using asApp() requests from Forge.

  • Destructive

    Create or update a Forge app property.

    Creates or updates a Forge app property. This API can only be accessed using asApp() requests from Forge.

  • Destructive

    Deletes a Forge app property.

    Deletes a Forge app property. This API can only be accessed using asApp() requests from Forge.

Audit

  • Read

    Get audit records

    Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

  • Read

    Export audit records

    Exports audit records as a CSV file or ZIP file. Permissions required: 'Confluence Administrator' global permission.

  • Read

    Get retention period

    Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted. Permissions required: 'Confluence Administrator' global permission.

  • Read

    Get audit records for time period

    Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records. This contains information about events like space exports, group membership changes, app installations, etc.

  • Write

    Create audit record

    Creates a record in the audit log. Permissions required: 'Confluence Administrator' global permission.

  • Destructive

    Set retention period

    Sets the retention period for records in the audit log. The retention period can be set to a maximum of 1 year. Permissions required: 'Confluence Administrator' global permission.

Experimental

  • Read

    Get Space Labels

    Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.

  • Write

    Add labels to a space

    Adds labels to a piece of content. Does not modify the existing labels. Notes: - Labels can also be added when creating content (Create content). - Labels can be updated when updating content (Update content).

  • Destructive

    Delete page tree

    Moves a pagetree rooted at a page to the space's trash: - If the content's type is page and its status is current, it will be trashed including all its descendants. - For every other combination of content type and status, this API is not supported.

  • Destructive

    Remove label from a space

    DELETE /wiki/rest/api/space/{spaceKey}/label

Content children and descendants

  • Write

    Copy page hierarchy

    Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.

  • Write

    Copy single page

    Copies a single page and its associated properties, permissions, attachments, and custom contents. The id path parameter refers to the content ID of the page to copy.

  • Destructive

    Move a page to a new location relative to a target page

    Move a page to a new location relative to a target page: before - move the page under the same parent as the target, before the target in the list of children after - move the page under the same parent as the target, after the target in the list of children append - move the pa…

Content attachments

  • Read

    Get URI to download attachment

    Redirects the client to a URL that serves an attachment's binary data.

  • Write

    Create attachment

    Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing attachment, use Create or update attachments. Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked.

  • Write

    Update attachment data

    Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field. This method is essentially the same as Create or update attachments, except that it matches the attachment ID rather than the name.

  • Destructive

    Create or update attachment

    Adds an attachment to a piece of content. If the attachment already exists for the content, then the attachment is updated (i.e. a new version of the attachment is created).

  • Destructive

    Update attachment properties

    Updates the attachment properties, i.e. the non-binary data of an attachment like the filename, media-type, comment, and parent container. Permissions required: Permission to update the content.

Content macro body

  • Read

    Get macro body by macro ID

    Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. This method is mainly used by Cloud apps.

  • Read

    Get macro body by macro ID and convert the representation synchronously

    Returns the body of a macro in format specified in path, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters.

  • Read

    Get macro body by macro ID and convert representation Asynchronously

    Returns Async Id of the conversion task which will convert the macro into a content body of the desired format. The result will be available for 5 minutes after completion of the conversion.

Content labels

  • Write

    Add labels to content

    Adds labels to a piece of content. Does not modify the existing labels. Notes: - Labels can also be added when creating content (Create content). - Labels can be updated when updating content (Update content).

  • Destructive

    Remove label from content using query parameter

    Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to Remove label from content except that the label name is specified via a query parameter.

  • Destructive

    Remove label from content

    Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to Remove label from content using query parameter except that the label name is specified via a path parameter.

Content watches

  • Read

    Get watches for page

    Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.

  • Read

    Get watches for space

    Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated.

  • Read

    Get space watchers

    Returns a list of watchers of a space

  • Read

    Get content watch status

    Returns whether a user is watching a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Read

    Get label watch status

    Returns whether a user is watching a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Read

    Get space watch status

    Returns whether a user is watching a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Write

    Add content watcher

    Adds a user as a watcher to a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Write

    Add label watcher

    Adds a user as a watcher to a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Write

    Add space watcher

    Adds a user as a watcher to a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Destructive

    Remove content watcher

    Removes a user as a watcher from a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Destructive

    Remove label watcher

    Removes a user as a watcher from a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

  • Destructive

    Remove space watch

    Removes a user as a watcher from a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used.

Content permissions

  • Read

    Check content permissions

    Check if a user or a group can perform an operation to the specified content. The operation to check must be provided. The user’s account ID or the ID of the group can be provided in the subject to check permissions against a specified user or group.

Content restrictions

  • Read

    Get restrictions

    Returns the restrictions on a piece of content. Permissions required: Permission to view the content.

  • Read

    Get restrictions by operation

    Returns restrictions on a piece of content by operation. This method is similar to Get restrictions except that the operations are properties of the return object, rather than items in a results array. Permissions required: Permission to view the content.

  • Read

    Get restrictions for operation

    Returns the restictions on a piece of content for a given operation (read or update). Permissions required: Permission to view the content.

  • Read

    Get content restriction status for group

    Returns whether the specified content restriction applies to a group.

  • Read

    Get content restriction status for user

    Returns whether the specified content restriction applies to a user.

  • Write

    Add restrictions

    Adds the supplied users and groups to the content's restrictions, preserving existing restrictions. Use read for viewing restrictions and update for editing restrictions. Omitted or empty user and group lists add no restrictions.

  • Destructive

    Update restrictions

    Updates restrictions for a piece of content. For each operation in the request, the supplied user and group lists replace the corresponding existing lists. Omitted operations and omitted user or group lists are preserved.

  • Destructive

    Delete restrictions

    Removes all restrictions (read and update) on a piece of content. Permissions required: Permission to edit the content.

  • Destructive

    Add group to content restriction

    Adds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a piece of content. Permissions required: Permission to edit the content.

  • Destructive

    Remove group from content restriction

    Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. Permissions required: Permission to edit the content.

  • Destructive

    Add user to content restriction

    Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content. Permissions required: Permission to edit the content.

  • Destructive

    Remove user from content restriction

    Removes a user from a content restriction. That is, remove read or update permission for the user for a piece of content. Permissions required: Permission to edit the content.

Content states

  • Read

    Get content state

    Gets the current content state of the draft or current version of content. To specify the draft version, set the parameter status to draft, otherwise archived or current will get the relevant published state. Permissions required: Permission to view the content.

  • Read

    Gets available content states for content.

    Gets content states that are available for the content to be set as. Will return all enabled Space Content States. Will only return most the 3 most recently published custom content states to match UI editor list.

  • Read

    Get Custom Content States

    Get custom content states that authenticated user has created. Permissions required Must have user authentication.

  • Read

    Get space suggested content states

    Get content states that are suggested in the space. Permissions required: 'View' permission for the space.

  • Read

    Get content state settings for space

    Get object describing whether content states are allowed at all, if custom content states or space content states are restricted, and a list of space content states allowed for the space if they are not restricted. Permissions required: 'Admin' permission for the space.

  • Read

    Get content in space with given content state

    Returns all content that has the provided content state in a space. If the expand query parameter is used with the body.exportview and/or body.styledview properties, then the query limit parameter will be restricted to a maximum value of 25.

  • Destructive

    Set the content state of a content and publishes a new version of the content.

    Sets the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new state. You may pass in either an id of a state, or the name and color of a desired new state.

  • Destructive

    Removes the content state of a content and publishes a new version.

    Removes the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new status. Permissions required: Permission to edit the content.

Content versions

  • Write

    Restore content version

    Restores a historical version to be the latest version. That is, a new version is created with the content of the historical version. Permissions required: Permission to update the content.

  • Destructive

    Delete content version

    Delete a historical version. This does not delete the changes made to the content in that version, rather the changes for the deleted version are rolled up into the next version. Note, you cannot delete the current version. Permissions required: Permission to update the content.

Content body

  • Read

    Get asynchronously converted content body from the id or the current status of the task.

    Returns the content body for the corresponding asyncId of a completed conversion task. If the task is not completed, the task status is returned instead.

  • Read

    Get asynchronous content body conversion task result in bulk

    Returns the content body for the corresponding asyncId of a completed conversion task. If the task is not completed, the task status is returned instead.

  • Write

    Asynchronously convert content body

    Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task.

  • Write

    Create asynchronous content body conversion tasks in bulk

    Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this endpoint.

Label info

  • Read

    Get label information

    Returns label information and a list of contents associated with the label. Permissions required: Permission to access the Confluence site ('Can use' global permission). Only contents that the user is permitted to view is returned.

Group

  • Read

    Get groups

    Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get group

    Returns a user group for a given group id. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Search groups by partial query

    Get search results of groups by partial query provided.

  • Read

    Get group members

    Returns the users that are members of a group. Use updated Get group API Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Write

    Create new user group

    Creates a new user group. Permissions required: User must be a site admin.

  • Write

    Add member to group by groupId

    Adds a user as a member in a group represented by its groupId Permissions required: User must be a site admin.

  • Destructive

    Delete user group

    Delete user group. Permissions required: User must be a site admin.

  • Destructive

    Remove member from group using group id

    Remove user as a member from a group. Permissions required: User must be a site admin.

Relation

  • Read

    Find target entities related to a source entity

    Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

  • Read

    Find relationship from source to target

    Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships are one way. For example, you can use this method to find whether the current user has selected a particular page as a favorite (i.e.

  • Read

    Find source entities related to a target entity

    Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

  • Destructive

    Create relationship

    Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by default, but you can use this method to create any type of relationship between two entities.

  • Destructive

    Delete relationship

    Deletes a relationship between two entities (user, space, content). Permissions required: Permission to access the Confluence site ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite relationships.

Search

  • Read

    Search content

    Searches for content using the Confluence Query Language (CQL). Note that CQL input queries submitted through the /wiki/rest/api/search endpoint no longer support user-specific fields like user, user.fullname, user.accountid, and user.userkey.

  • Read

    Search users

    Searches for users using user-specific queries from the Confluence Query Language (CQL). Note that CQL input queries submitted through the /wiki/rest/api/search/user endpoint only support user-specific fields like user, user.fullname, user.accountid, and user.userkey.

Settings

  • Read

    Get look and feel settings

    Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius. The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.

  • Read

    Get system info

    Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Write

    Update look and feel settings

    Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.

  • Destructive

    Select look and feel settings

    Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's settings for a space. The custom and theme settings can only be selected if there is already a theme set for a space.

  • Destructive

    Reset look and feel settings

    Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected.

Themes

  • Read

    Get themes

    Returns all themes, not including the default theme. Permissions required: None

  • Read

    Get global theme

    Returns the globally assigned theme. Permissions required: None

  • Read

    Get theme

    Returns a theme. This includes information about the theme name, description, and icon. Permissions required: None

  • Read

    Get space theme

    Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings. Permissions required: ‘View’ permission for the space.

  • Destructive

    Set space theme

    Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the 'Reset space theme' method instead of this method. Permissions required: 'Admin' permission for the space.

  • Destructive

    Reset space theme

    Resets the space theme. This means that the space will inherit the global look and feel settings Permissions required: 'Admin' permission for the space.

Space permissions

  • Write

    Add new permission to space

    Adds new permission to space. If the permission to be added is a group permission, the group can be identified by its group name or group id. Note: Apps cannot access this REST resource - including when utilizing user impersonation.

  • Write

    Add new custom content permission to space

    Adds new custom content permission to space. If the permission to be added is a group permission, the group can be identified by its group name or group id. Note: Only apps can access this REST resource and only make changes to the respective app permissions.

  • Destructive

    Remove a space permission

    Removes a space permission. Note that removing Read Space permission for a user or group will remove all the space permissions for that user or group. Note: Apps cannot access this REST resource - including when utilizing user impersonation.

Space settings

  • Read

    Get space settings

    Returns the settings of a space. Permissions required: 'View' permission for the space.

  • Destructive

    Update space settings

    Updates the settings for a space. Permissions required: manage/space permission for the space. Note: To find the display name for each permission ID, call the Get available space permissions API.

Template

  • Read

    Get blueprint templates

    Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space. Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the global blueprints.

  • Read

    Get content templates

    Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.

  • Read

    Get content template

    Returns a content template. This includes information about template, like the name, the space or blueprint that the template is in, the body of the template, and more.

  • Write

    Create content template

    Creates a new content template. Note, blueprint templates cannot be created via the REST API. Permissions required: 'Admin' permission for the space to create a space template or 'Confluence Administrator' global permission to create a global template.

  • Destructive

    Update content template

    Updates a content template. Note, blueprint templates cannot be updated via the REST API. Permissions required: 'Admin' permission for the space to update a space template or 'Confluence Administrator' global permission to update a global template.

  • Destructive

    Remove template

    Deletes a template. This results in different actions depending on the type of template: - If the template is a content template, it is deleted.

Users

  • Read

    Get user

    Returns a user. This includes information about the user, such as the display name, account ID, profile picture, and more. The information returned may be restricted by the user's profile visibility settings.

  • Read

    Get anonymous user

    Returns information about how anonymous users are represented, like the profile picture and display name. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get current user

    Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get group memberships for user

    Returns the groups that a user is a member of. Permissions required: Permission to access the Confluence site ('Can use' global permission).

  • Read

    Get multiple users using ids

    Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If more than 100 account ids are passed in, then the first 100 will be returned.

  • Read

    Get user email address

    Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.

  • Read

    Get user email addresses in batch

    Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.

Dynamic modules

  • Read

    Get modules

    Returns all modules registered dynamically by the calling app. Permissions required: Only Connect apps can make this request.

  • Write

    Register modules

    Registers a list of modules. For the list of modules that support dynamic registration, see Dynamic modules. Permissions required: Only Connect apps can make this request.

  • Destructive

    Remove modules

    Remove all or a list of modules registered by the calling app. Permissions required: Only Connect apps can make this request.

Analytics

  • Read

    Get views

    Get the total number of views a piece of content has.

  • Read

    Get viewers

    Get the total number of distinct viewers a piece of content has.

User properties

  • Read

    Get user properties

    Returns the properties for a user as list of property keys. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

  • Read

    Get user property

    Returns the property corresponding to key for a user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

  • Write

    Create user property by key

    Creates a property for a user. For more information about user properties, see [Confluence entity properties] (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

  • Destructive

    Update user property

    Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties.

  • Destructive

    Delete user property

    Deletes a property for the given user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

See How connections work for access and permissions, or browse all integrations.