How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Confluence Cloud REST API v1

The legacy Confluence Cloud REST surface under /wiki/rest/api. 130 operations, still the only place several capabilities are published — CQL search, audit records, groups and users, content restrictions, templates and blueprints, themes and look-and-feel, relations, watchers, long-running tasks and attachment upload.

Confluence Cloud REST API v1 is one of 4 APIs that Atlassian Confluence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Search, Content, Users, Groups, and Audit. 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 130 operations across 89 paths, organized into 28 resource areas, and defines 168 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, //your-domain.atlassian.net.

130 operations 89 paths 168 schemas 22 DELETE65 GET27 POST16 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0
Terms of Service
Resource Areas
28

Authentication & Security 2

Confluence Cloud REST API v1 declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 76 scopes.

  • basicAuth — You can access this resource via basic auth.
  • oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.

Paths & Operations 130

Across 89 paths, the API surfaces 130 operations — 22 DELETE, 65 GET, 27 POST, 16 PUT. They span 28 resource areas, including Audit, Content, Experimental, Content - children and descendants, Content - attachments, Content - macro body, Content labels, Content watches, and 20 more. Each is listed below with its method, path, parameters, and response codes.

Audit 6
GET
/wiki/rest/api/audit
Get audit records
getAuditRecords 5 params → 200401403
POST
/wiki/rest/api/audit
Create audit record
createAuditRecord body → 200400401
GET
/wiki/rest/api/audit/export
Export audit records
exportAuditRecords 4 params → 200403
GET
/wiki/rest/api/audit/retention
Get retention period
getRetentionPeriod → 200403
PUT
/wiki/rest/api/audit/retention
Set retention period
setRetentionPeriod body → 200403
GET
/wiki/rest/api/audit/since
Get audit records for time period
getAuditRecordsForTimePeriod 5 params → 200403
Content 4
POST
/wiki/rest/api/content/archive
Archive pages
archivePages body → 202400401
PUT
/wiki/rest/api/content/blueprint/instance/{draftId}
Publish shared draft
publishSharedDraft 3 params body → 200400409
POST
/wiki/rest/api/content/blueprint/instance/{draftId}
Publish legacy draft
publishLegacyDraft 3 params body → 200400409
GET
/wiki/rest/api/content/search
Search content by CQL
searchContentByCQL 5 params → 200400401
Experimental 4

APIs in this section can change without any prior deprecation notice.

DELETE
/wiki/rest/api/content/{id}/pageTree
Delete page tree
deletePageTree 1 param → 202400401403404
GET
/wiki/rest/api/space/{spaceKey}/label
Get Space Labels
getLabelsForSpace 4 params → 200404
POST
/wiki/rest/api/space/{spaceKey}/label
Add labels to a space
addLabelsToSpace 1 param body → 200400403404
DELETE
/wiki/rest/api/space/{spaceKey}/label
Remove label from a space
deleteLabelFromSpace 3 params → 204400404
Content - children and descendants 5
PUT
/wiki/rest/api/content/{pageId}/move/{position}/{targetId}
Move a page to a new location relative to a target page
movePage 3 params → 200400403404
GET
/wiki/rest/api/content/{id}/descendantdeprecated
Get content descendants
getContentDescendants 2 params → 200404
GET
/wiki/rest/api/content/{id}/descendant/{type}deprecated
Get content descendants by type
getDescendantsOfType 6 params → 200400404
POST
/wiki/rest/api/content/{id}/pagehierarchy/copy
Copy page hierarchy
copyPageHierarchy 1 param body → 202400403404
POST
/wiki/rest/api/content/{id}/copy
Copy single page
copyPage 2 params body → 200400401403404
Content - attachments 5
PUT
/wiki/rest/api/content/{id}/child/attachment
Create or update attachment
createOrUpdateAttachments 2 params body → 200403404
POST
/wiki/rest/api/content/{id}/child/attachment
Create attachment
createAttachment 2 params body → 200400403404
PUT
/wiki/rest/api/content/{id}/child/attachment/{attachmentId}
Update attachment properties
updateAttachmentProperties 2 params body → 200400403404409
POST
/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data
Update attachment data
updateAttachmentData 2 params body → 200400404
GET
/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download
Get URI to download attachment
downloadAttatchment 4 params → 302400401404
Content - macro body 3
GET
/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}
Get macro body by macro ID
getMacroBodyByMacroId 3 params → 200401404
GET
/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}
Get macro body by macro ID and convert the representation synchronously
getAndConvertMacroBodyByMacroId 7 params → 200400401404
GET
/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}
Get macro body by macro ID and convert representation Asynchronously
getAndAsyncConvertMacroBodyByMacroId 8 params → 200401404
Content labels 3
POST
/wiki/rest/api/content/{id}/label
Add labels to content
addLabelsToContent 1 param body → 200400403404
DELETE
/wiki/rest/api/content/{id}/label
Remove label from content using query parameter
removeLabelFromContentUsingQueryParameter 2 params → 204403404
DELETE
/wiki/rest/api/content/{id}/label/{label}
Remove label from content
removeLabelFromContent 2 params → 204400403404
Content watches 12
GET
/wiki/rest/api/content/{id}/notification/child-created
Get watches for page
getWatchesForPage 3 params → 200401
GET
/wiki/rest/api/content/{id}/notification/created
Get watches for space
getWatchesForSpace 3 params → 200401
GET
/wiki/rest/api/space/{spaceKey}/watch
Get space watchers
getWatchersForSpace 3 params → 200404
GET
/wiki/rest/api/user/watch/content/{contentId}
Get content watch status
getContentWatchStatus 4 params → 200403404
POST
/wiki/rest/api/user/watch/content/{contentId}
Add content watcher
addContentWatcher 4 params → 204403404
DELETE
/wiki/rest/api/user/watch/content/{contentId}
Remove content watcher
removeContentWatcher 5 params → 204403404
GET
/wiki/rest/api/user/watch/label/{labelName}
Get label watch status
isWatchingLabel 4 params → 200403404
POST
/wiki/rest/api/user/watch/label/{labelName}
Add label watcher
addLabelWatcher 5 params → 204403404
DELETE
/wiki/rest/api/user/watch/label/{labelName}
Remove label watcher
removeLabelWatcher 4 params → 204403404
GET
/wiki/rest/api/user/watch/space/{spaceKey}
Get space watch status
isWatchingSpace 4 params → 200403404
POST
/wiki/rest/api/user/watch/space/{spaceKey}
Add space watcher
addSpaceWatcher 5 params → 204403404
DELETE
/wiki/rest/api/user/watch/space/{spaceKey}
Remove space watch
removeSpaceWatch 4 params → 204403404
Content permissions 1
POST
/wiki/rest/api/content/{id}/permission/check
Check content permissions
checkContentPermission 1 param body → 200400401403404
Content restrictions 12
GET
/wiki/rest/api/content/{id}/restriction
Get restrictions
getRestrictions 4 params → 200404
PUT
/wiki/rest/api/content/{id}/restriction
Update restrictions
updateRestrictions 2 params body → 200404
POST
/wiki/rest/api/content/{id}/restriction
Add restrictions
addRestrictions 2 params body → 200404
DELETE
/wiki/rest/api/content/{id}/restriction
Delete restrictions
deleteRestrictions 2 params → 200400403404
GET
/wiki/rest/api/content/{id}/restriction/byOperation
Get restrictions by operation
getRestrictionsByOperation 2 params → 200
GET
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}
Get restrictions for operation
getRestrictionsForOperation 5 params → 200
GET
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
Get content restriction status for group
getIndividualGroupRestrictionStatusByGroupId 3 params → 200403404
PUT
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
Add group to content restriction
addGroupToContentRestrictionByGroupId 3 params → 200400403404
DELETE
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
Remove group from content restriction
removeGroupFromContentRestriction 3 params → 200400403404
GET
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
Get content restriction status for user
getContentRestrictionStatusForUser 5 params → 200404
PUT
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
Add user to content restriction
addUserToContentRestriction 5 params → 200400404
DELETE
/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
Remove user from content restriction
removeUserFromContentRestriction 5 params → 200404
Content states 8
GET
/wiki/rest/api/content/{id}/state
Get content state
getContentState 2 params → 200401403404
PUT
/wiki/rest/api/content/{id}/state
Set the content state of a content and publishes a new version of the content.
setContentState 2 params body → 200400401403404
DELETE
/wiki/rest/api/content/{id}/state
Removes the content state of a content and publishes a new version.
removeContentState 2 params → 200401403404
GET
/wiki/rest/api/content/{id}/state/available
Gets available content states for content.
getAvailableContentStates 1 param → 200400401403404
GET
/wiki/rest/api/content-states
Get Custom Content States
getCustomContentStates → 200401
GET
/wiki/rest/api/space/{spaceKey}/state
Get space suggested content states
getSpaceContentStates 1 param → 200401403404
GET
/wiki/rest/api/space/{spaceKey}/state/settings
Get content state settings for space
getContentStateSettings 1 param → 200401403404
GET
/wiki/rest/api/space/{spaceKey}/state/content
Get content in space with given content state
getContentsWithState 5 params → 200400401403404
Content versions 2
POST
/wiki/rest/api/content/{id}/version
Restore content version
restoreContentVersion 2 params body → 200400403
DELETE
/wiki/rest/api/content/{id}/version/{versionNumber}
Delete content version
deleteContentVersion 2 params → 204400403
Content body 4
POST
/wiki/rest/api/contentbody/convert/async/{to}
Asynchronously convert content body
asyncConvertContentBodyRequest 6 params body → 200400404
GET
/wiki/rest/api/contentbody/convert/async/{id}
Get asynchronously converted content body from the id or the current status of the task.
asyncConvertContentBodyResponse 1 param → 200400401403404
POST
/wiki/rest/api/contentbody/convert/async/bulk/tasks
Create asynchronous content body conversion tasks in bulk
bulkAsyncConvertContentBodyRequest body → 200400
GET
/wiki/rest/api/contentbody/convert/async/bulk/tasks
Get asynchronous content body conversion task result in bulk
bulkAsyncConvertContentBodyResponse 1 param → 200400
Label info 1
GET
/wiki/rest/api/label
Get label information
getAllLabelContent 4 params → 200400403404
Group 8

[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/) The standard Atlassian group names are default names only and can be edited or deleted. For…

GET
/wiki/rest/api/group
Get groups
getGroups 3 params → 200403
POST
/wiki/rest/api/group
Create new user group
createGroup body → 201400401403
GET
/wiki/rest/api/group/by-id
Get group
getGroupByGroupId 1 param → 200403404
DELETE
/wiki/rest/api/group/by-id
Delete user group
removeGroupById 1 param → 204400401403404
GET
/wiki/rest/api/group/picker
Search groups by partial query
searchGroups 4 params → 200403
GET
/wiki/rest/api/group/{groupId}/membersByGroupId
Get group members
getGroupMembersByGroupId 5 params → 200400403
POST
/wiki/rest/api/group/userByGroupId
Add member to group by groupId
addUserToGroupByGroupId 1 param body → 201400401403404
DELETE
/wiki/rest/api/group/userByGroupId
Remove member from group using group id
removeMemberFromGroupByGroupId 4 params → 204400401403404
Long-running task 2
GET
/wiki/rest/api/longtask
Get long-running tasks
getTasks 3 params → 200401
GET
/wiki/rest/api/longtask/{id}
Get long-running task
getTask 1 param → 200401404
Relation 5
GET
/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}
Find target entities related to a source entity
findTargetFromSource 11 params → 200400403404
GET
/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
Find relationship from source to target
getRelationship 10 params → 200400401403404
PUT
/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
Create relationship
createRelationship 9 params → 200400401403404
DELETE
/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
Delete relationship
deleteRelationship 9 params → 204400401403404
GET
/wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}
Find source entities related to a target entity
findSourcesForTarget 11 params → 200400403404
Search 2
GET
/wiki/rest/api/search
Search content
searchByCQL 13 params → 200400403
GET
/wiki/rest/api/search/user
Search users
searchUser 5 params → 200400403
Settings 5
GET
/wiki/rest/api/settings/lookandfeel
Get look and feel settings
getLookAndFeelSettings 1 param → 200400404
PUT
/wiki/rest/api/settings/lookandfeel
Select look and feel settings
updateLookAndFeel body → 200400403404409
POST
/wiki/rest/api/settings/lookandfeel/custom
Update look and feel settings
updateLookAndFeelSettings 1 param body → 200400403404
DELETE
/wiki/rest/api/settings/lookandfeel/custom
Reset look and feel settings
resetLookAndFeelSettings 1 param → 204400403404
GET
/wiki/rest/api/settings/systemInfo
Get system info
getSystemInfo → 200403
Themes 6
GET
/wiki/rest/api/settings/theme
Get themes
getThemes 2 params → 200
GET
/wiki/rest/api/settings/theme/selected
Get global theme
getGlobalTheme → 200404
GET
/wiki/rest/api/settings/theme/{themeKey}
Get theme
getTheme 1 param → 200404
GET
/wiki/rest/api/space/{spaceKey}/theme
Get space theme
getSpaceTheme 1 param → 200404
PUT
/wiki/rest/api/space/{spaceKey}/theme
Set space theme
setSpaceTheme 1 param body → 200403404
DELETE
/wiki/rest/api/space/{spaceKey}/theme
Reset space theme
resetSpaceTheme 1 param → 204404
Space 4
POST
/wiki/rest/api/space
Create space
createSpace body → 200400401403
POST
/wiki/rest/api/space/_private
Create private space
createPrivateSpace body → 200400401403
PUT
/wiki/rest/api/space/{spaceKey}
Update space
updateSpace 1 param body → 200401404
DELETE
/wiki/rest/api/space/{spaceKey}
Delete space
deleteSpace 1 param → 202401404
Space permissions 3
POST
/wiki/rest/api/space/{spaceKey}/permission
Add new permission to space
addPermissionToSpace 1 param body → 200400401403404
POST
/wiki/rest/api/space/{spaceKey}/permission/custom-content
Add new custom content permission to space
addCustomContentPermissions 1 param body → 200400401403404
DELETE
/wiki/rest/api/space/{spaceKey}/permission/{id}
Remove a space permission
removePermission 2 params → 204400401403404
Space settings 2
GET
/wiki/rest/api/space/{spaceKey}/settings
Get space settings
getSpaceSettings 1 param → 200401404
PUT
/wiki/rest/api/space/{spaceKey}/settings
Update space settings
updateSpaceSettings 1 param body → 200401404
Template 6
PUT
/wiki/rest/api/template
Update content template
updateContentTemplate body → 200400403404
POST
/wiki/rest/api/template
Create content template
createContentTemplate body → 200400403
GET
/wiki/rest/api/template/blueprint
Get blueprint templates
getBlueprintTemplates 4 params → 200403
GET
/wiki/rest/api/template/page
Get content templates
getContentTemplates 4 params → 200403
GET
/wiki/rest/api/template/{contentTemplateId}
Get content template
getContentTemplate 2 params → 200403
DELETE
/wiki/rest/api/template/{contentTemplateId}
Remove template
removeTemplate 1 param → 204403
Users 7
GET
/wiki/rest/api/user
Get user
getUser 2 params → 200401403404
GET
/wiki/rest/api/user/anonymous
Get anonymous user
getAnonymousUser 1 param → 200403
GET
/wiki/rest/api/user/current
Get current user
getCurrentUser 1 param → 200403
GET
/wiki/rest/api/user/memberof
Get group memberships for user
getGroupMembershipsForUser 3 params → 200403
GET
/wiki/rest/api/user/bulk
Get multiple users using ids
getBulkUserLookup 2 params → 200403
GET
/wiki/rest/api/user/email
Get user email address
getPrivacyUnsafeUserEmail 1 param → 200400401404501
GET
/wiki/rest/api/user/email/bulk
Get user email addresses in batch
getPrivacyUnsafeUserEmailBulk 1 param → 200400401501
Dynamic modules 3
GET
/wiki/rest/atlassian-connect/1/app/module/dynamic
Get modules
getModules → 200401
POST
/wiki/rest/atlassian-connect/1/app/module/dynamic
Register modules
registerModules body → 200400401
DELETE
/wiki/rest/atlassian-connect/1/app/module/dynamic
Remove modules
removeModules 1 param → 204401
Analytics 2
GET
/wiki/rest/api/analytics/content/{contentId}/views
Get views
getViews 2 params → 200400401403404
GET
/wiki/rest/api/analytics/content/{contentId}/viewers
Get viewers
getViewers 2 params → 200400401403404
User properties 5
GET
/wiki/rest/api/user/{userId}/property
Get user properties
getUserProperties 3 params → 200400401403404
GET
/wiki/rest/api/user/{userId}/property/{key}
Get user property
getUserProperty 2 params → 200400401403404
PUT
/wiki/rest/api/user/{userId}/property/{key}
Update user property
updateUserProperty 2 params body → 204400401403404
POST
/wiki/rest/api/user/{userId}/property/{key}
Create user property by key
createUserProperty 2 params body → 201400401403404409
DELETE
/wiki/rest/api/user/{userId}/property/{key}
Delete user property
deleteUserProperty 2 params → 204400401403404

Schemas 168

The contract defines 168 schemas that model the data the API accepts and returns. The most detailed are Content (20 properties), User (18 properties), Space (18 properties), BulkUserLookup (17 properties). Each schema is shown below with its type and property counts.

AccountId
object
1 property 1 required
AccountIdEmailRecord
object
2 properties 2 required
AccountIdEmailRecordArray
array
AffectedObject
object
2 properties 2 required
AsyncId
object
1 property 1 required
AsyncIdArray
array
AttachmentUpdate
object
6 properties 3 required
AuditRecord
object
11 properties 10 required
AuditRecordArray
object
5 properties 5 required
AuditRecordCreate
object
10 properties 1 required
AvailableContentStates
object
2 properties 2 required
BlueprintTemplate
object
12 properties 8 required
BlueprintTemplateArray
object
5 properties 5 required
ButtonLookAndFeel
object
2 properties 2 required
Breadcrumb
object
3 properties 3 required
ChangedValue
object
5 properties 3 required
ConnectModule
object
A [Connect module](https://developer.atlassian.com/cloud/confluence/modules/admin-page/) in the same format as in the [app descriptor](https://developer.atlass…
ConnectModules
object
1 property 1 required
Container
object
Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
ContainerLookAndFeel
object
12 properties 6 required
ContainerSummary
object
2 properties 2 required
AttachmentPropertiesUpdateBody
object
8 properties 3 required
Content
object
Base object for all content types.
20 properties 2 required
ContentArray
object
5 properties 3 required
ContentBlogpost
Representation of a blogpost (content)
ContentBlueprintDraft
object
6 properties 3 required
AsyncContentBody
object
10 properties
AsyncContentBodyArray
array
ContentBody
object
7 properties 2 required
ContentBodyCreate
object
This object is used when creating or updating content.
2 properties 2 required
ContentChildren
object
9 properties
ContentBodyCreateStorage
object
This object is used when creating or updating content.
2 properties 2 required
ContentChildType
object
Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.
4 properties
ContentCreate
object
8 properties 1 required
ContentHistory
object
11 properties 1 required
ContentId
string
ContentLookAndFeel
object
4 properties
ContentMetadata
object
Metadata object for page, blogpost, comment content
4 properties
ContentProperty
object
6 properties 4 required
ContentPropertyArray
object
5 properties 5 required
ContentPropertyCreate
object
2 properties 2 required
ContentPropertyCreateNoKey
object
1 property 1 required
ContentPropertyUpdate
object
2 properties 2 required
ContentRestriction
object
5 properties 3 required
ContentRestrictionArray
object
6 properties 6 required
ContentRestrictionUpdate
object
3 properties 2 required
ContentRestrictionAddOrUpdateArray
AddContentRestriction
object
2 properties 2 required
AddContentRestrictionUpdateArray
array
ContentPageResponse
object
4 properties 4 required
ContentState
object
3 properties 3 required
ContentStateRestInput
object
3 properties
ContentStateResponse
object
2 properties
ContentStateSettings
object
4 properties 3 required
ContentTemplate
object
12 properties 6 required
ContentTemplateArray
object
5 properties 5 required
ContentTemplateCreate
object
This object is used to create content templates.
6 properties 3 required
ContentTemplateBody
object
The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage. Note, edito…
9 properties
ContentTemplateBodyCreate
object
The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage. Note, edito…
9 properties
ContentTemplateUpdate
object
This object is used to update content templates.
7 properties 4 required
ContentUpdate
object
6 properties 2 required
ContentBodyConversionInput
object
7 properties 2 required
BulkContentBodyConversionInput
object
1 property
CopyPageHierarchyRequest
object
8 properties 1 required
CopyPageHierarchyTitleOptions
object
Required for copying page in the same space.
3 properties
CopyPageRequest
object
8 properties 1 required
CopyPageRequestDestination
object
Defines where the page will be copied to, and can be one of the following types. - parentpage: page will be copied as a child of the specified parent page - pa…
2 properties 2 required
CQLPersonalDataConvertedQueries
object
The converted CQL queries.
1 property 1 required
CQLPersonalDataMigrationRequest
object
The CQL queries to be converted.
1 property 1 required
DynamicModulesErrorMessage
object
1 property 1 required
Embeddable
object
EmbeddedContent
object
3 properties
GenericAccountId
string
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
GenericLinks
object
GenericUserName
string
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
GenericUserKey
string
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
GlobalSpaceIdentifier
object
1 property 1 required
Group
object
6 properties 3 required
GroupCreate
object
2 properties 1 required
GroupArray
object
4 properties 4 required
GroupArrayWithLinks
object
Same as GroupArray but with links property.
6 properties 5 required
GroupName
object
1 property 1 required
HeaderLookAndFeel
object
5 properties 5 required
HorizontalHeaderLookAndFeel
object
5 properties 2 required
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.
4 properties 4 required
Label
object
4 properties 4 required
LabelArray
object
5 properties 2 required
LabeledContent
object
3 properties 3 required
LabeledContentType
string
LabeledContentPageResponse
object
4 properties 2 required
LabelDetails
object
2 properties 1 required
LabelCreate
object
2 properties 2 required
LabelCreateArray
array
LongTask
object
3 properties 2 required
LookAndFeel
object
8 properties 6 required
LookAndFeelWithLinks
Look and feel settings returned after an update.
LookAndFeelSelection
object
Look and feel selection
2 properties 2 required
LookAndFeelSettings
object
4 properties 3 required
LongTaskStatus
object
Current status of a long running task Status keys: - ERRORUNKNOWN - Generic error - ERRORLOCKFAILED - Could not get the lock on destination space - ERRORRELINK…
11 properties 7 required
LongTaskStatusArray
object
5 properties 5 required
LongTaskStatusWithLinks
object
Same as LongTaskStatus but with links property. Status keys: - ERRORUNKNOWN - Generic error - ERRORLOCKFAILED - Could not get the lock on destination space - E…
12 properties 8 required
MacroInstance
object
4 properties
MenusLookAndFeel
object
2 properties 2 required
Message
object
2 properties 1 required
BulkUserLookup
object
17 properties 9 required
BulkUserLookupArray
object
5 properties 5 required
NavigationLookAndFeel
object
3 properties 2 required
TopNavigationLookAndFeel
object
3 properties 1 required
OperationCheckResult
object
An operation and the target entity that it applies to, e.g. create page.
2 properties 2 required
PropertyValue
The value of the property. This can be empty or a complex object. 64KB Size Limit For example, "value": { "example1": "value", "example2": true, "example3": 12…
Relation
object
6 properties 2 required
RelationArray
object
5 properties 5 required
RelationData
object
3 properties
RetentionPeriod
object
2 properties 2 required
ScreenLookAndFeel
object
15 properties 1 required
SearchFieldLookAndFeel
object
2 properties 2 required
SearchPageResponseSearchResult
object
9 properties 8 required
SearchResult
object
14 properties 7 required
Space
object
18 properties 6 required
SpaceArray
object
5 properties 5 required
SpaceCreate
object
This is the request object used when creating a new space.
5 properties 1 required
SpaceUpdate
object
The properties of a space that can be updated.
5 properties
SpaceDescription
object
3 properties 3 required
SpaceDescriptionCreate
object
The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.
1 property 1 required
SpacePermission
object
This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following c…
5 properties 3 required
SpacePermissionCreate
object
This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following c…
4 properties 3 required
SpaceProperty
object
7 properties 4 required
SpacePropertyArray
object
5 properties 5 required
SpacePropertyCreate
object
3 properties 2 required
SpacePropertyCreateNoKey
object
1 property 1 required
SpacePropertyUpdate
object
4 properties 2 required
SpaceSettings
object
5 properties 2 required
SpaceSettingsUpdate
object
2 properties
SpaceWatch
object
5 properties 2 required
SpaceWatchArray
object
5 properties 4 required
SuperBatchWebResources
object
4 properties
SystemInfoEntity
object
9 properties 2 required
TaskStatusUpdate
object
1 property 1 required
Task
object
15 properties 6 required
TaskPageResponse
object
4 properties 4 required
Theme
object
5 properties 1 required
ThemeNoLinks
object
Theme object without links. Used in ThemeArray.
4 properties 1 required
ThemeArray
object
5 properties 5 required
ThemeUpdate
object
1 property 1 required
User
object
18 properties 1 required
UserAnonymous
object
6 properties 4 required
UserArray
object
6 properties 1 required
UserDetails
object
2 properties
UserProperty
object
6 properties 5 required
UserPropertyKeyArray
object
5 properties 1 required
UserPropertyCreate
object
1 property 1 required
UserPropertyUpdate
object
1 property 1 required
UsersUserKeys
object
3 properties 1 required
UserWatch
object
1 property 1 required
Version
object
14 properties 3 required
VersionArray
object
5 properties 5 required
VersionRestore
object
2 properties 2 required
Watch
object
3 properties 3 required
WatchArray
object
5 properties 5 required
WatchUser
object
This essentially the same as the User object, but no links property and no expandable property (therefore, different required fields).
16 properties 12 required
WebResourceDependencies
object
6 properties
PermissionSubject
object
The user or group that the permission applies to.
2 properties 2 required
PermissionSubjectWithGroupId
object
The user or group that the permission applies to.
2 properties 2 required
SpacePermissionV2
object
This object represents a single space permission. Permissions consist of at least one operation object with an accompanying subjects object. The following comb…
4 properties 3 required
SpacePermissionRequest
object
This object represents the request for the single space permission. Permissions consist of one operation object with an accompanying subjects object. The follo…
3 properties 2 required
SpacePermissionCustomContent
object
This object represents a list of space permissions for custom content type for an individual user. Permissions consist of a subjects object and a list with at…
2 properties 2 required
ContentPermissionRequest
object
This object represents the request for the content permission check API.
2 properties 2 required
PermissionCheckResponse
object
This object represents the response for the content permission check API. If the user or group does not have permissions, the following errors may be returned:…
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-confluence-rest-v1-openapi.json Raw ↑

Other APIs Atlassian Confluence publishes across the network.

Confluence Cloud REST API v2
Confluence Cloud GraphQL API
Atlassian Rovo MCP Server (Confluence tools)
Where this information came from

This is an independent, third-party profile of Confluence Cloud REST API v1, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.