Skip to main content

Copy 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. The target of the page to be copied is defined using the destination in the request body and can be one of the following types.

  • space: page will be copied to the specified space as a root page on the space
  • parent_page: page will be copied as a child of the specified parent page
  • existing_page: page will be copied and replace the specified page

By default, the following objects are expanded: space, history, version.

Permissions required: 'Add' permission for the space that the content will be copied in and permission to update the content if copying to an existing_page.

External Documentation

To learn more, visit the Confluence documentation.

Parameters​

ParameterDescription
Copy AttachmentsIf set to true, attachments are copied to the destination page.
Copy Custom ContentsIf set to true, custom contents are copied to the destination page.
Copy LabelsIf set to true, labels are copied to the destination page.
Copy PermissionsIf set to true, page permissions are copied to the destination page.
Copy PropertiesIf set to true, content properties are copied to the destination page.
Destination Type-
Destination ValueThe space key for space type, and content id for parent_page and existing_page.
Editor2 RepresentationThe content format type. Set the value of this property tothe name of the format being used, e.g. 'storage'.
Editor2 ValueThe body of the content in the relevant format.
ExpandA multi-value parameter indicating which properties of the content to expand.
  • childTypes.all returns whether the content has attachments, comments, or child pages.Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the informationreturned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content,including when they last viewed it, modified it, contributed to it, or added it as a favorite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend this property is only used by Atlassian.
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content. Note thatthis may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content. Note thatthis may return deleted groups because deleting a group doesn't remove associated restrictions.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, includingwho updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format,view format, and export format.
  • version returns information about the most recent update of the content, including who updated itand when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned byGet space.
In addition, the following comment-specific expansions can be used:
  • extensions.inlineProperties returns inline comment-specific properties.
  • extensions.resolution returns the resolution status of each comment.
ID-
Page TitleIf defined, this will replace the title of the destination page.
Storage RepresentationThe content format type. Set the value of this property tothe name of the format being used, e.g. 'storage'.
Storage ValueThe body of the content in the relevant format.

Example Output​

{
"_expandable": {
"ancestors": "string",
"body": "string",
"childTypes": "string",
"children": "string",
"container": "string",
"descendants": "string",
"history": "string",
"metadata": "string",
"operations": "string",
"restrictions": "string",
"space": "string",
"version": "string"
},
"_links": {},
"ancestors": [
null
],
"body": {
"_expandable": {
"anonymous_export_view": "string",
"editor": "string",
"editor2": "string",
"export_view": "string",
"storage": "string",
"styled_view": "string",
"view": "string"
},
"anonymous_export_view": {
"_expandable": {
"content": "string"
},
"embeddedContent": [
{
"entity": {},
"entityId": 0
}
],
"representation": "string",
"value": "string",
"webresource": {
"contexts": [
"string"
],
"keys": [
"string"
],
"superbatch": {
"metatags": "string",
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
},
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
}
},
"editor2": {
"_expandable": {
"content": "string"
},
"embeddedContent": [
{
"entity": {},
"entityId": 0
}
],
"representation": "string",
"value": "string",
"webresource": {
"contexts": [
"string"
],
"keys": [
"string"
],
"superbatch": {
"metatags": "string",
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
},
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
}
},
"export_view": {
"_expandable": {
"content": "string"
},
"embeddedContent": [
{
"entity": {},
"entityId": 0
}
],
"representation": "string",
"value": "string",
"webresource": {
"contexts": [
"string"
],
"keys": [
"string"
],
"superbatch": {
"metatags": "string",
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
},
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
}
},
"storage": {
"_expandable": {
"content": "string"
},
"embeddedContent": [
{
"entity": {},
"entityId": 0
}
],
"representation": "string",
"value": "string",
"webresource": {
"contexts": [
"string"
],
"keys": [
"string"
],
"superbatch": {
"metatags": "string",
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
},
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
}
},
"styled_view": {
"_expandable": {
"content": "string"
},
"embeddedContent": [
{
"entity": {},
"entityId": 0
}
],
"representation": "string",
"value": "string",
"webresource": {
"contexts": [
"string"
],
"keys": [
"string"
],
"superbatch": {
"metatags": "string",
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
},
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
}
},
"view": {
"_expandable": {
"content": "string"
},
"embeddedContent": [
{
"entity": {},
"entityId": 0
}
],
"representation": "string",
"value": "string",
"webresource": {
"contexts": [
"string"
],
"keys": [
"string"
],
"superbatch": {
"metatags": "string",
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
},
"tags": {
"all": "string",
"css": "string",
"data": "string",
"js": "string"
},
"uris": {
"all": "string",
"css": "string",
"js": "string"
}
}
}
},
"childTypes": {
"_expandable": {
"all": "string",
"attachment": "string",
"comment": "string",
"page": "string"
},
"attachment": {
"_links": {},
"value": false
},
"comment": {
"_links": {},
"value": false
},
"page": {
"_links": {},
"value": false
}
},
"children": {
"_expandable": {
"attachment": "string",
"comment": "string",
"page": "string"
},
"_links": {},
"attachment": {
"_links": {},
"limit": 0,
"results": [
null
],
"size": 0,
"start": 0
},
"comment": {
"_links": {},
"limit": 0,
"results": [
null
],
"size": 0,
"start": 0
},
"page": {
"_links": {},
"limit": 0,
"results": [
null
],
"size": 0,
"start": 0
}
},
"container": {},
"descendants": {
"_expandable": {
"attachment": "string",
"comment": "string",
"page": "string"
},
"_links": {},
"attachment": {
"_links": {},
"limit": 0,
"results": [
null
],
"size": 0,
"start": 0
},
"comment": {
"_links": {},
"limit": 0,
"results": [
null
],
"size": 0,
"start": 0
},
"page": {
"_links": {},
"limit": 0,
"results": [
null
],
"size": 0,
"start": 0
}
},
"history": {
"_expandable": {
"contributors": "string",
"lastUpdated": "string",
"nextVersion": "string",
"previousVersion": "string"
},
"_links": {},
"contributors": {
"publishers": {
"_links": {},
"userKeys": [
"string"
],
"users": [
{
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
}
]
}
},
"createdBy": {
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"createdDate": "date-time",
"lastUpdated": {
"_expandable": {
"collaborators": "string",
"content": "string"
},
"_links": {},
"by": {
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"collaborators": {
"_links": {},
"userKeys": [
"string"
],
"users": [
{
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
}
]
},
"friendlyWhen": "string",
"message": "string",
"minorEdit": false,
"number": 0,
"when": "date-time"
},
"latest": false,
"nextVersion": {
"_expandable": {
"collaborators": "string",
"content": "string"
},
"_links": {},
"by": {
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"collaborators": {
"_links": {},
"userKeys": [
"string"
],
"users": [
{
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
}
]
},
"friendlyWhen": "string",
"message": "string",
"minorEdit": false,
"number": 0,
"when": "date-time"
},
"previousVersion": {
"_expandable": {
"collaborators": "string",
"content": "string"
},
"_links": {},
"by": {
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
],
"size": 0,
"start": 0
}
},
"name": "string",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"permissions": [
{
"anonymousAccess": false,
"operation": {
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
},
"subjects": {
"_expandable": {
"group": "string",
"user": "string"
},
"group": {
"results": [
{
"_links": {},
"id": "string",
"name": "string",
"type": "group"
}
],
"size": 0
},
"user": {
"results": [
null
],
"size": 0
}
},
"unlicensedAccess": false
}
],
"settings": {
"_links": {},
"routeOverrideEnabled": false
},
"status": "string",
"theme": {
"_links": {},
"description": "string",
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"name": "string",
"themeKey": "string"
},
"type": "string"
},
"profilePicture": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"publicName": "The public name or nickname of the user. Will always contain a value.",
"type": "string",
"userKey": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"username": "This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"collaborators": {
"_links": {},
"userKeys": [
"string"
],
"users": [
{
"_expandable": {
"details": "string",
"operations": "string",
"personalSpace": "string"
},
"_links": {},
"accountId": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"accountType": "The account type of the user, may return empty string if unavailable.",
"details": {
"business": {
"department": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"location": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal": {
"email": "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"website": "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"displayName": "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"email": "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"operations": [
{
"operation": "The operation itself.",
"targetType": "The space or content type that the operation applies to."
}
],
"personalSpace": {
"_expandable": {
"description": "string",
"history": "string",
"homepage": "string",
"icon": "string",
"lookAndFeel": "string",
"metadata": "string",
"operations": "string",
"permissions": "string",
"settings": "string",
"theme": "string"
},
"_links": {},
"description": {
"plain": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
},
"view": {
"embeddedContent": [
{}
],
"representation": "string",
"value": "string"
}
},
"history": {
"createdDate": "date-time"
},
"icon": {
"height": 0,
"isDefault": false,
"path": "string",
"width": 0
},
"id": 0,
"key": "string",
"lookAndFeel": {
"bordersAndDividers": {
"color": "string"
},
"content": {
"body": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"container": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"header": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"borderRadius": "string",
"padding": "string"
},
"screen": {
"background": "string",
"backgroundColor": "string",
"backgroundImage": "string",
"backgroundSize": "string",
"gutterBottom": "string",
"gutterLeft": "string",
"gutterRight": "string",
"gutterTop": "string"
}
},
"header": {
"backgroundColor": "string",
"button": {
"backgroundColor": "string",
"color": "string"
},
"primaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
},
"search": {
"backgroundColor": "string",
"color": "string"
},
"secondaryNavigation": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string",
"color": "string"
}
}
},
"headings": {
"color": "string"
},
"links": {
"color": "string"
},
"menus": {
"color": "string",
"hoverOrFocus": {
"backgroundColor": "string"
}
}
},
"metadata": {
"labels": {
"_links": {},
"limit": 0,
"results": [
{
"id": "string",
"label": "string",
"name": "string",
"prefix": "string"
}
]