Confluence Cloud REST API v2
The recommended Confluence Cloud REST surface. 218 cursor-paginated operations under /wiki/api/v2 covering pages, blog posts, spaces, attachments, comments, labels, versions, tasks, custom content, databases, folders, whiteboards, smart links, space roles and permissions, classification levels and content properties.
Confluence Cloud REST API v2 is one of 4 APIs that Atlassian Confluence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Pages, Spaces, Attachments, Comments, and Labels. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a getting-started guide.
This API exposes
218 operations
across 151 paths,
organized into 30 resource areas,
and defines 142 schemas.
It is described by OpenAPI 3.0.3, at version 2.0.0.
Requests are made against a single base URL, https://{your-domain}/wiki/api/v2.
The identity and technical contract details declared by the specification.
AdminKeyResponse
object
2 properties
AttachmentSingle
object
20 properties
AttachmentBulk
object
16 properties
BlogPostSingle
object
15 properties
BlogPostBulk
object
9 properties
TaskBodySingle
object
Contains fields for each representation type requested.
2 properties
BodySingle
object
Contains fields for each representation type requested.
3 properties
BodyBulk
object
Contains fields for each representation type requested.
2 properties
BodyType
object
2 properties
PrimaryBodyRepresentation
string
The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.
PrimaryBodyRepresentationSingle
string
The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.
CustomContentBodyRepresentation
string
The formats a custom content body can be represented as. A subset of BodyRepresentation.
CustomContentBodyRepresentationSingle
string
The formats a custom content body can be represented as. A subset of BodyRepresentation.
SpaceDescriptionBodyRepresentation
string
The formats a space description can be represented as. A subset of BodyRepresentation.
ContentIdToContentTypeResponse
object
1 property
ContentStatus
string
The status of the content.
BlogPostContentStatus
string
The status of the content.
OnlyArchivedAndCurrentContentStatus
string
The status of the content.
ContentProperty
object
4 properties
ContentPropertyCreateRequest
object
2 properties
ContentPropertyUpdateRequest
object
3 properties
CustomContentSingle
object
17 properties
CustomContentBulk
object
13 properties
CustomContentBodySingle
object
Contains fields for each representation type requested.
4 properties
CustomContentBodyBulk
object
Contains fields for each representation type requested.
3 properties
DetailedVersion
object
9 properties
Label
object
3 properties
Operation
object
2 properties
PermittedOperationsResponse
object
The list of operations permitted on entity.
1 property
PageSingle
object
20 properties
PageBulk
object
15 properties
ParentContentType
string
Content type of the parent, or null if there is no parent.
PageBodyWrite
object
2 properties
PageNestedBodyWrite
object
Body of the page. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
BlogPostBodyWrite
object
2 properties
BlogPostNestedBodyWrite
object
Body of the blog post. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
CommentBodyWrite
object
2 properties
CommentNestedBodyWrite
object
Body of the comment. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
CustomContentBodyWrite
object
2 properties
CustomContentNestedBodyWrite
object
Body of the custom content. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
ChildPage
object
5 properties
ChildCustomContent
object
5 properties
ChildrenResponse
object
6 properties
DescendantsResponse
object
7 properties
WhiteboardSingle
object
13 properties
DatabaseSingle
object
13 properties
SmartLinkSingle
object
14 properties
FolderSingle
object
13 properties
Ancestor
object
2 properties
AncestorType
string
The type of ancestor.
Redaction
object
1 property
RedactionPointer
object
4 properties
1 required
RedactionResponse
object
Response containing details of all redactions that were applied to the content. Each redaction includes a unique ID for restoration, except that code block red…
2 properties
RedactionSectionResponse
object
1 property
RedactionPointerResponse
object
5 properties
SpaceSingle
object
16 properties
SpaceBulk
object
13 properties
SpaceDescription
object
Contains fields for each representation type requested.
2 properties
SpaceIcon
object
The icon of the space
2 properties
SpacePermission
object
4 properties
SpacePermissionAssignment
object
3 properties
SpaceRole
object
5 properties
UpdateSpaceRoleResponse
object
5 properties
DeleteSpaceRoleResponse
object
1 property
BulkTransitionTaskResponse
object
3 properties
3 required
BulkTransitionTaskStatusResponse
object
3 properties
2 required
BulkAssignRolesRequest
object
2 properties
2 required
BulkRemoveAccessRequest
object
2 properties
2 required
BulkTransitionRoleAssignment
object
2 properties
2 required
BulkTransitionPrincipalTypeAssignment
object
3 properties
2 required
BulkTransitionSpaceSelection
object
2 properties
1 required
BulkTransitionSpaceTarget
object
2 properties
2 required
ListSpacePermissionCombinationsResponse
object
3 properties
1 required
BulkTransitionCombinationEntry
object
5 properties
5 required
BulkTransitionDecodedPermission
object
2 properties
2 required
SpaceRoleAssignment
object
2 properties
Principal
object
The principal of the role assignment.
2 properties
PrincipalType
string
The principal type.
RoleType
string
The role type.
SpaceProperty
object
6 properties
SpacePropertyCreateRequest
object
2 properties
SpacePropertyUpdateRequest
object
3 properties
SpaceType
string
The type of space.
SpaceStatus
string
The status of the space.
Task
object
14 properties
AccountType
string
The account type of the user.
AccountStatus
string
The account status of the user.
Icon
object
This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
2 properties
2 required
User
object
10 properties
Version
object
5 properties
AttachmentVersion
object
6 properties
BlogPostVersion
object
6 properties
PageVersion
object
6 properties
CustomContentVersion
object
6 properties
CommentVersion
object
6 properties
VersionedEntity
object
3 properties
AttachmentSortOrder
string
The sort fields for attachments. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example,…
BlogPostSortOrder
string
The sort fields for blog posts. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example,…
CommentSortOrder
string
The sort fields for comments. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fi…
ContentPropertySortOrder
string
The sort fields for content properties. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For e…
ContentSortOrder
string
The sort fields for hierarchical content types. The default sort direction is ascending. To sort in descending order, append a - character before the sort fiel…
LabelSortOrder
string
The sort fields for labels. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fiel…
ChildPageSortOrder
string
The sort fields for child pages. The default sort direction is ascending by child-position. To sort in descending order, append a - character before the sort f…
ChildCustomContentSortOrder
string
The sort fields for child custom content. The default sort direction is ascending by id. To sort in descending order, append a - character before the sort fiel…
CustomContentSortOrder
string
The sort fields for custom content. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For examp…
PageSortOrder
string
The sort fields for pages. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, field…
SpaceSortOrder
string
The sort fields for spaces. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fiel…
VersionSortOrder
string
The sort fields for versions. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fi…
InlineCommentResolutionStatus
string
Inline comment resolution status
InlineCommentProperties
object
2 properties
PageCommentModel
object
7 properties
PageInlineCommentModel
object
9 properties
BlogPostCommentModel
object
7 properties
BlogPostInlineCommentModel
object
9 properties
ChildrenCommentModel
object
7 properties
InlineCommentChildrenModel
object
9 properties
AttachmentCommentModel
object
7 properties
CustomContentCommentModel
object
7 properties
FooterCommentModel
object
15 properties
InlineCommentModel
object
16 properties
CreateFooterCommentModel
object
6 properties
CreateInlineCommentModel
object
5 properties
UpdateFooterCommentModel
object
2 properties
UpdateInlineCommentModel
object
3 properties
AbstractPageLinks
object
3 properties
AttachmentLinks
object
2 properties
CustomContentLinks
object
1 property
CommentLinks
object
1 property
DatabaseLinks
object
1 property
FolderLinks
object
1 property
SmartLinkLinks
object
1 property
SpaceLinks
object
1 property
WhiteboardLinks
object
2 properties
DataPolicyMetadata
object
Details about data policies.
1 property
DataPolicySpace
object
7 properties
OptionalFieldMeta
object
2 properties
OptionalFieldLinks
object
1 property
MultiEntityLinks
object
2 properties
ClassificationLevel
object
A unit of [data classification](https://support.atlassian.com/security-and-access-policies/docs/what-is-data-classification/) defined by an organiation. A clas…
7 properties
ClassificationLevelColor
string
ClassificationLevelStatus
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Atlassian Confluence publishes across the network.