Confluence (version v1.*.*)

groupName (required)#

The name of the group to add to the content restriction.

Type: string

id (required)#

The ID of the content that the restriction applies to.

Type: string

operationKey (required)#

The operation that the restriction applies to.

Type: string

Potential values: read, update

id (required)#

The ID of the content that will have labels added to it.

Type: string

$body#

The labels to add to the content.

Type: array

[ {
  "prefix" : "The prefix for the label.",
  "name" : "The name of the label, which will be shown in the UI."
} ]

id (required)#

The ID of the content to add restrictions to.

Type: string

$body#

The restrictions to be added to the content.

Type: array

[ {
  "restrictions" : {
    "user" : [ {
      "accountId" : "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required, unless `username` or `userKey` is specified.",
      "type" : "Set to 'known'.",
      "userKey" : "This property has been deprecated due to privacy changes. Use `accountId` instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe user key of the user. Required, unless `accountId` or `username` is specified.",
      "username" : "This property has been deprecated due to privacy changes. Use `accountId` instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe username of the user. For example, _admin_. Required, unless `accountId` or `userKey` is specified."
    } ],
    "group" : [ {
      "name" : "The name of the group.",
      "type" : "Set to 'group'."
    } ]
  },
  "operation" : "The restriction operation applied to content."
} ]

expand#

A multi-value parameter indicating which properties of the content
restrictions (returned in response) to expand.

• restrictions.user returns the piece of content that the restrictions are
  applied to. Expanded by default.
• restrictions.group returns the piece of content that the restrictions are
  applied to. Expanded by default.
• content returns the piece of content that the restrictions are
  applied to.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

id (required)#

The ID of the content that the restriction applies to.

Type: string

operationKey (required)#

The operation that the restriction applies to.

Type: string

accountId#

The account ID of the user to add to the content restriction. The accountId uniquely identifies the user across
all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to add to the content restriction. Required, unless the username or accountId is specified.

Type: string

userName#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to add to the content restriction. Required, unless the key or accountId is specified.

Type: string

contentId (required)#

The ID of the content to add the watcher to.

Type: string

accountId#

The accountId of the user to be added as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be added as a watcher. Required, unless the username or accountId is specified.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be added as a watcher. Required, unless the key or accountId is specified.

Type: string

labelName (required)#

The name of the label to add the watcher to.

Type: string

accountId#

The accountId of the user to be added as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be added as a watcher. Required, unless the username or accountId is specified.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be added as a watcher. Required, unless the key or accountId is specified.

Type: string

spaceKey (required)#

The key of the space to add the watcher to.

Type: string

accountId#

The accountId of the user to be added as a watcher. The accountId uniquely identifies the user across all
Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be added as a watcher. Required, unless the username or accountId is specified.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be added as a watcher. Required, unless the key or accountId is specified.

Type: string

to (required)#

The name of the target format for the content body.

Type: string

$body#

The content body to convert.

Type: object

{
  "value" : "The body of the content in the relevant format.",
  "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
}

contentIdContext#

The content ID used to find the space for resolving embedded content
(page includes, files, and links) in the content body. For example,
if the source content contains the link ``
and the contentIdContext=123 parameter is provided, then the link
will be converted to a link to the "Example page" page in the same space
that has the content with ID=123. Note, spaceKeyContext will be ignored
if this parameter is provided.

Type: string

embeddedContentRender#

Mode used for rendering embedded content, like attachments.

• current renders the embedded content using the latest version.
• version-at-save renders the embedded content using the version at
  the time of save.

Type: string

Potential values: current, version-at-save

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

spaceKeyContext#

The space key used for resolving embedded content (page includes,
files, and links) in the content body. For example, if the source content
contains the link ``
and the spaceKeyContext=TEST parameter is provided, then the link
will be converted to a link to the "Example page" page in the "TEST" space.

Type: string

$body#

The CQL queries to convert.

Type: object

{
  "queryStrings" : [ "string" ]
}

id (required)#

Type: string

$body#

Request object from json post body

Type: object

{
  "copyAttachments" : "boolean",
  "originalPageId" : "string",
  "copyPermissions" : "boolean",
  "copyLabels" : "boolean",
  "copyProperties" : "boolean",
  "destinationPageId" : "ContentId",
  "titleOptions" : {
    "search" : "string",
    "prefix" : "string",
    "replace" : "string"
  }
}

$body#

The record to be created in the audit log.

Type: object

{
  "summary" : "The summary of the event, which is displayed in the 'Change' column on\nthe audit log in the Confluence UI.",
  "changedValues" : [ {
    "newValue" : "Required string",
    "name" : "Required string",
    "oldValue" : "Required string"
  } ],
  "author" : {
    "operations" : { },
    "displayName" : "The name that is displayed on the audit log in the Confluence UI.",
    "type" : "Set to 'user'.",
    "userKey" : "The userKey of the user that actioned the event.",
    "username" : "The username of the user that actioned the event."
  },
  "affectedObject" : {
    "name" : "Required string",
    "objectType" : "Required string"
  },
  "description" : "A long description of the event, which is displayed in the 'Description'\nfield on the audit log in the Confluence UI.",
  "associatedObjects" : [ {
    "name" : "Required string",
    "objectType" : "Required string"
  } ],
  "sysAdmin" : "Indicates whether the event was actioned by a system administrator.",
  "creationDate" : "The creation date-time of the audit record, as a timestamp. This is converted\nto a date-time display in the Confluence UI. If the `creationDate` is not\nspecified, then it will be set to the timestamp for the current date-time.",
  "category" : "The category of the event, which is displayed in the 'Event type' column\non the audit log in the Confluence UI.",
  "remoteAddress" : "The IP address of the computer where the event was initiated from."
}

$body#

The new content to be created. Set the representation to the name of the body
format type. For example, if you use storage for the body format, set
'representation=storage'.

If you are not sure how to generate the different formats, you can create a page in the
Confluence application, retrieve the content using Get content,
and expand the desired content format, e.g. expand=body.storage.

Type: object

{
  "id" : "The ID of the draft content. Required when publishing a draft.",
  "title" : "Required string",
  "type" : "The type of the new content. Custom content types defined by apps are also supported.",
  "ancestors" : [ {
    "id" : "The `id` of the parent content."
  } ],
  "body" : {
    "view" : {
      "value" : "The body of the content in the relevant format.",
      "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
    },
    "export_view" : {
      "value" : "The body of the content in the relevant format.",
      "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
    },
    "styled_view" : {
      "value" : "The body of the content in the relevant format.",
      "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
    },
    "storage" : {
      "value" : "The body of the content in the relevant format.",
      "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
    },
    "editor2" : {
      "value" : "The body of the content in the relevant format.",
      "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
    },
    "anonymous_export_view" : {
      "value" : "The body of the content in the relevant format.",
      "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
    }
  },
  "space" : {
    "key" : "The key of the space."
  },
  "status" : "The status of the new content."
}

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

status#

Filter the returned content by status.

Type: string

$body#

The content template to be created.
The content body must be in 'storage' format.

Type: object

{
  "templateType" : "The type of the new template. Set to `page`.",
  "name" : "The name of the new template.",
  "description" : "A description of the new template.",
  "body" : {
    "value" : "The body of the content in the relevant format.",
    "representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
  },
  "space" : {
    "key" : "Required string"
  },
  "labels" : [ {
    "prefix" : "Required string",
    "name" : "Required string",
    "id" : "Required string",
    "label" : "Required string"
  } ]
}

$body#

The space to be created.

Type: object

{
  "name" : "The name of the new space.",
  "description" : {
    "plain" : {
      "value" : "The space description.",
      "representation" : "Set to 'plain'."
    }
  },
  "key" : "The key for the new space. Format: See [Space\nkeys](https://confluence.atlassian.com/x/lqNMMQ)."
}

id (required)#

The ID of the content to add the property to.

Type: string

$body#

The content property to be created.

Type: object

{
  "value" : { },
  "key" : "The key of the new property."
}

id (required)#

The ID of the content to add the property to.

Type: string

key (required)#

The key of the content property. Required.

Type: string

$body#

The content property to be created.

Type: object

{
  "value" : { }
}

key (required)#

The key of the property to be created.

Type: string

spaceKey (required)#

The key of the space that the property will be created in.

Type: string

$body#

The space property to be created.

Type: object

{
  "value" : { }
}

spaceKey (required)#

The key of the space that the property will be created in.

Type: string

$body#

The space property to be created.

Type: object

{
  "value" : { },
  "key" : "The key of the new property."
}

relationName (required)#

The name of the relationship. This method supports the 'favourite'
(i.e. 'save for later') relationship. You can also specify any other
value for this parameter to create a custom relationship type.

Type: string

sourceKey (required)#

• The identifier for the source entity:

• If sourceType is 'user', then specify either 'current' (logged-in
  user) or the user key.

• If sourceType is 'content', then specify the content ID.

• If sourceType is 'space', then specify the space key.

Type: string

sourceType (required)#

The source entity type of the relationship. This must be 'user', if
the relationName is 'favourite'.

Type: string

Potential values: user, content, space

targetKey (required)#

• The identifier for the target entity:

• If sourceType is 'user', then specify either 'current' (logged-in
  user) or the user key.

• If sourceType is 'content', then specify the content ID.

• If sourceType is 'space', then specify the space key.

Type: string

targetType (required)#

The target entity type of the relationship. This must be 'space' or
'content', if the relationName is 'favourite'.

Type: string

Potential values: user, content, space

sourceStatus#

The status of the source. This parameter is only used when the
sourceType is 'content'.

Type: string

sourceVersion#

The version of the source. This parameter is only used when the
sourceType is 'content' and the sourceStatus is 'historical'.

Type: integer

targetStatus#

The status of the target. This parameter is only used when the
targetType is 'content'.

Type: string

targetVersion#

The version of the target. This parameter is only used when the
targetType is 'content' and the targetStatus is 'historical'.

Type: integer

$body#

The space to be created.

Type: object

{
  "permissions" : [ {
    "anonymousAccess" : "Grant anonymous users permission to use the operation.",
    "subjects" : {
      "_expandable" : {
        "user" : "string",
        "group" : "string"
      },
      "user" : {
        "size" : "Required integer",
        "results" : [ {
          "_links" : "Required object",
          "displayName" : "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
          "accountType" : "The account type of the user, may return empty string if unavailable.",
          "type" : "Required string. Possible values: known | unknown | anonymous | user",
          "userKey" : "This property has been deprecated in favor of `accountId`, due to privacy changes. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe user key of the user.",
          "accountId" : "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
          "profilePicture" : {
            "path" : "Required string",
            "isDefault" : "Required boolean",
            "width" : "Required integer",
            "height" : "Required integer"
          },
          "operations" : [ {
            "targetType" : "The space or content type that the operation applies to.",
            "operation" : "The operation itself."
          } ],
          "publicName" : "The public name or nickname of the user. Will always contain a value.",
          "details" : {
            "business" : {
              "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.",
              "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."
            },
            "personal" : {
              "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.",
              "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.",
              "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."
            }
          },
          "_expandable" : {
            "operations" : "string",
            "details" : "string",
            "personalSpace" : "string"
          },
          "email" : "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
          "username" : "This property has been deprecated in favor of `accountId`, due to privacy changes. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe username of the user. For example, _admin_.",
          "personalSpace" : {
            "settings" : {
              "_links" : "Required object",
              "routeOverrideEnabled" : "Defines whether an override for the space home should be used. This is\nused in conjunction with a space theme provided by an app. For\nexample, if this property is set to true, a theme can display a page\nother than the space homepage when users visit the root URL for a\nspace. This property allows apps to provide content-only theming\nwithout overriding the space home."
            },
            "metadata" : {
              "labels" : {
                "size" : "Required integer",
                "_links" : "Required object",
                "start" : "Required integer",
                "limit" : "Required integer",
                "results" : [ {
                  "prefix" : "Required string",
                  "name" : "Required string",
                  "id" : "Required string",
                  "label" : "Required string"
                } ]
              }
            },
            "_links" : "Required object",
            "icon" : {
              "path" : "Required string",
              "isDefault" : "Required boolean",
              "width" : "Required integer",
              "height" : "Required integer"
            },
            "description" : {
              "view" : {
                "embeddedContent" : [ { } ],
                "value" : "Required string",
                "representation" : "Required string. Possible values: plain | view"
              },
              "plain" : {
                "embeddedContent" : [ { } ],
                "value" : "Required string",
                "representation" : "Required string. Possible values: plain | view"
              }
            },
            "history" : {
              "createdDate" : "Required date-time"
            },
            "type" : "Required string",
            "operations" : [ {
              "targetType" : "The space or content type that the operation applies to.",
              "operation" : "The operation itself."
            } ],
            "lookAndFeel" : {
              "bordersAndDividers" : {
                "color" : "Required string"
              },
              "headings" : {
                "color" : "Required string"
              },
              "header" : {
                "button" : {
                  "backgroundColor" : "Required string",
                  "color" : "Required string"
                },
                "backgroundColor" : "Required string",
                "primaryNavigation" : {
                  "color" : "Required string",
                  "hoverOrFocus" : {
                    "backgroundColor" : "Required string",
                    "color" : "Required string"
                  }
                },
                "search" : {
                  "backgroundColor" : "Required string",
                  "color" : "Required string"
                },
                "secondaryNavigation" : {
                  "color" : "Required string",
                  "hoverOrFocus" : {
                    "backgroundColor" : "Required string",
                    "color" : "Required string"
                  }
                }
              },
              "links" : {
                "color" : "Required string"
              },
              "menus" : {
                "color" : "Required string",
                "hoverOrFocus" : {
                  "backgroundColor" : "Required string"
                }
              },
              "content" : {
                "container" : {
                  "padding" : "Required string",
                  "backgroundColor" : "Required string",
                  "borderRadius" : "Required string",
                  "background" : "Required string",
                  "backgroundImage" : "Required string",
                  "backgroundSize" : "Required string"
                },
                "screen" : {
                  "gutterRight" : "Required string",
                  "gutterLeft" : "Required string",
                  "gutterTop" : "Required string",
                  "backgroundColor" : "Required string",
                  "background" : "Required string",
                  "backgroundImage" : "Required string",
                  "backgroundSize" : "Required string",
                  "gutterBottom" : "Required string"
                },
                "header" : {
                  "padding" : "Required string",
                  "backgroundColor" : "Required string",
                  "borderRadius" : "Required string",
                  "background" : "Required string",
                  "backgroundImage" : "Required string",
                  "backgroundSize" : "Required string"
                },
                "body" : {
                  "padding" : "Required string",
                  "backgroundColor" : "Required string",
                  "borderRadius" : "Required string",
                  "background" : "Required string",
                  "backgroundImage" : "Required string",
                  "backgroundSize" : "Required string"
                }
              }
            },
            "permissions" : [ "SpacePermission" ],
            "name" : "Required string",
            "theme" : {
              "name" : "Required string",
              "icon" : {
                "path" : "Required string",
                "isDefault" : "Required boolean",
                "width" : "Required integer",
                "height" : "Required integer"
              },
              "description" : "Required string",
              "themeKey" : "Required string",
              "_links" : "Required object"
            },
            "id" : "Required integer",
            "_expandable" : {
              "settings" : "string",
              "metadata" : "string",
              "operations" : "string",
              "lookAndFeel" : "string",
              "permissions" : "string",
              "icon" : "string",
              "description" : "string",
              "theme" : "string",
              "history" : "string",
              "homepage" : "string"
            },
            "key" : "Required string",
            "homepage" : {
              "container" : { },
              "_links" : "object",
              "restrictions" : {
                "read" : {
                  "_links" : "Required object",
                  "restrictions" : {
                    "_expandable" : {
                      "user" : "string",
                      "group" : "string"
                    },
                    "user" : {
                      "size" : "Required integer",
                      "start" : "Required integer",
                      "limit" : "Required integer",
                      "results" : [ "User" ]
                    },
                    "group" : {
                      "size" : "Required integer",
                      "start" : "Required integer",
                      "limit" : "Required integer",
                      "results" : [ {
                        "_links" : "Required object",
                        "name" : "Required string",
                        "type" : "Required string. Possible values: group"
                      } ]
                    }
                  },
                  "_expandable" : {
                    "restrictions" : "string",
                    "content" : "string"
                  },
                  "operation" : "Required string. Possible values: administer | copy | create | delete | export | move | purge | purge_version | read | restore | update | use",
                  "content" : "Content"
                },
                "_links" : "Required object",
                "update" : {
                  "_links" : "Required object",
                  "restrictions" : {
                    "_expandable" : {
                      "user" : "string",
                      "group" : "string"
                    },
                    "user" : {
                      "size" : "Required integer",
                      "start" : "Required integer",
                      "limit" : "Required integer",
                      "results" : [ "User" ]
                    },
                    "group" : {
                      "size" : "Required integer",
                      "start" : "Required integer",
                      "limit" : "Required integer",
                      "results" : [ {
                        "_links" : "Required object",
                        "name" : "Required string",
                        "type" : "Required string. Possible values: group"
                      } ]
                    }
                  },
                  "_expandable" : {
                    "restrictions" : "string",
                    "content" : "string"
                  },
                  "operation" : "Required string. Possible values: administer | copy | create | delete | export | move | purge | purge_version | read | restore | update | use",
                  "content" : "Content"
                }
              },
              "history" : {
                "lastUpdated" : {
                  "number" : "Required integer",
                  "minorEdit" : "Required boolean",
                  "_links" : "Required object",
                  "by" : "Required User",
                  "friendlyWhen" : "Required string",
                  "collaborators" : {
                    "_links" : "object",
                    "userKeys" : [ "string" ],
                    "users" : [ "User" ]
                  },
                  "message" : "Required string",
                  "_expandable" : {
                    "collaborators" : "Required string",
                    "content" : "Required string"
                  },
                  "when" : "Required date-time",
                  "content" : "Content"
                },
                "createdDate" : "Required date-time",
                "createdBy" : "Required User",
                "_links" : "object",
                "previousVersion" : {
                  "number" : "Required integer",
                  "minorEdit" : "Required boolean",
                  "_links" : "Required object",
                  "by" : "Required User",
                  "friendlyWhen" : "Required string",
                  "collaborators" : {
                    "_links" : "object",
                    "userKeys" : [ "string" ],
                    "users" : [ "User" ]
                  },
                  "message" : "Required string",
                  "_expandable" : {
                    "collaborators" : "Required string",
                    "content" : "Required string"
                  },
                  "when" : "Required date-time",
                  "content" : "Content"
                },
                "contributors" : {
                  "publishers" : {
                    "_links" : "object",
                    "userKeys" : [ "string" ],
                    "users" : [ "User" ]
                  }
                },
                "_expandable" : {
                  "lastUpdated" : "string",
                  "previousVersion" : "string",
                  "contributors" : "string",
                  "nextVersion" : "string"
                },
                "nextVersion" : {
                  "number" : "Required integer",
                  "minorEdit" : "Required boolean",
                  "_links" : "Required object",
                  "by" : "Required User",
                  "friendlyWhen" : "Required string",
                  "collaborators" : {
                    "_links" : "object",
                    "userKeys" : [ "string" ],
                    "users" : [ "User" ]
                  },
                  "message" : "Required string",
                  "_expandable" : {
                    "collaborators" : "Required string",
                    "content" : "Required string"
                  },
                  "when" : "Required date-time",
                  "content" : "Content"
                },
                "latest" : "Required boolean"
              },
              "type" : "Required string",
              "title" : "Required string",
              "body" : {
                "view" : {
                  "webresource" : {
                    "uris" : {
                      "all" : "string",
                      "css" : "string",
                      "js" : "string"
                    },
                    "keys" : [ "string" ],
                    "superbatch" : {
                      "uris" : {
                        "all" : "string",
                        "css" : "string",
                        "js" : "string"
                      },
                      "metatags" : "string",
                      "tags" : {
                        "all" : "string",
                        "css" : "string",
                        "data" : "string",
                        "js" : "string"
                      }
                    },
                    "contexts" : [ "string" ],
                    "tags" : {
                      "all" : "string",
                      "css" : "string",
                      "data" : "string",
                      "js" : "string"
                    }
                  },
                  "embeddedContent" : [ {
                    "entityId" : "integer",
                    "entity" : { }
                  } ],
                  "_expandable" : {
                    "content" : "string"
                  },
                  "value" : "Required string",
                  "representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
                },
                "export_view" : {
                  "webresource" : {
                    "uris" : {
                      "all" : "string",
                      "css" : "string",
                      "js" : "string"
                    },
                    "keys" : [ "string" ],
                    "superbatch" : {
                      "uris" : {
                        "all" : "string",
                        "css" : "string",
                        "js" : "string"
                      },
                      "metatags" : "string",
                      "tags" : {
                        "all" : "string",
                        "css" : "string",
                        "data" : "string",
                        "js" : "string"
                      }
                    },
                    "contexts" : [ "string" ],
                    "tags" : {
                      "all" : "string",
                      "css" : "string",
                      "data" : "string",
                      "js" : "string"
                    }
                  },
                  "embeddedContent" : [ {
                    "entityId" : "integer",
                    "entity" : { }
                  } ],
                  "_expandable" : {
                    "content" : "string"
                  },
                  "value" : "Required string",
                  "representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
                },
                "styled_view" : {
                  "webresource" : {
                    "uris" : {
                      "all" : "string",
                      "css" : "string",
                      "js" : "string"
                    },
                    "keys" : [ "string" ],
                    "superbatch" : {
                      "uris" : {
                        "all" : "string",
                        "css" : "string",
                        "js" : "string"
                      },
                      "metatags" : "string",
                      "tags" : {
                        "all" : "string",
                        "css" : "string",
                        "data" : "string",
                        "js" : "string"
                      }
                    },
                    "contexts" : [ "string" ],
                    "tags" : {
                      "all" : "string",
                      "css" : "string",
                      "data" : "string",
                      "js" : "string"
                    }
                  },
                  "embeddedContent" : [ {
                    "entityId" : "integer",
                    "entity" : { }
                  } ],
                  "_expandable" : {
                    "content" : "string"
                  },
                  "value" : "Required string",
                  "representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
                },
                "storage" : {
                  "webresource" : {
                    "uris" : {
                      "all" : "string",
                      "css" : "string",
                      "js" : "string"
                    },
                    "keys" : [ "string" ],
                    "superbatch" : {
                      "uris" : {
                        "all" : "string",
                        "css" : "string",
                        "js" : "string"
                      },
                      "metatags" : "string",
                      "tags" : {
                        "all" : "string",
                        "css" : "string",
                        "data" : "string",
                        "js" : "string"
                      }
                    },
                    "contexts" : [ "string" ],
                    "tags" : {
                      "all" : "string",
                      "css" : "string",
                      "data" : "string",
                      "js" : "string"
                    }
                  },
                  "embeddedContent" : [ {
                    "entityId" : "integer",
                    "entity" : { }
                  } ],
                  "_expandable" : {
                    "content" : "string"
                  },
                  "value" : "Required string",
                  "representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
                },
                "_expandable" : {
                  "editor" : "string",
                  "view" : "string",
                  "export_view" : "string",
                  "styled_view" : "string",
                  "storage" : "string",
                  "editor2" : "string",
                  "anonymous_export_view" : "string"
                },
                "editor2" : {
                  "webresource" : {
                    "uris" : {
                      "all" : "string",
                      "css" : "string",
                      "js" : "string"
                    },
                    "keys" : [ "string" ],
                    "superbatch" : {
                      "uris" : {
                        "all" : "string",
                        "css" : "string",
                        "js" : "string"
                      },
                      "metatags" : "string",
                      "tags" : {
                        "all" : "string",
                        "css" : "string",
                        "data" : "string",
                        "js" : "string"
                      }
                    },
                    "contexts" : [ "string" ],
                    "tags" : {
                      "all" : "string",
                      "css" : "string",
                      "data" : "string",
                      "js" : "string"
                    }
                  },
                  "embeddedContent" : [ {
                    "entityId" : "integer",
                    "entity" : { }
                  } ],
                  "_expandable" : {
                    "content" : "string"
                  },
                  "value" : "Required string",
                  "representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
                },
                "anonymous_export_view" : {
                  "webresource" : {
                    "uris" : {
                      "all" : "string",
                      "css" : "string",
                      "js" : "string"
                    },
                    "keys" : [ "string" ],
                    "superbatch" : {
                      "uris" : {
                        "all" : "string",
                        "css" : "string",
                        "js" : "string"
                      },
                      "metatags" : "string",
                      "tags" : {
                        "all" : "string",
                        "css" : "string",
                        "data" : "string",
                        "js" : "string"
                      }
                    },
                    "contexts" : [ "string" ],
                    "tags" : {
                      "all" : "string",
                      "css" : "string",
                      "data" : "string",
                      "js" : "string"
                    }
                  },
                  "embeddedContent" : [ {
                    "entityId" : "integer",
                    "entity" : { }
                  } ],
                  "_expandable" : {
                    "content" : "string"
                  },
                  "value" : "Required string",
                  "representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
                }
              },
              "version" : {
                "number" : "Required integer",
                "minorEdit" : "Required boolean",
                "_links" : "Required object",
                "by" : "Required User",
                "friendlyWhen" : "Required string",
                "collaborators" : {
                  "_links" : "object",
                  "userKeys" : [ "string" ],
                  "users" : [ "User" ]
                },
                "message" : "Required string",
                "_expandable" : {
                  "collaborators" : "Required string",
                  "content" : "Required string"
                },
                "when" : "Required date-time",
                "content" : "Content"
              },
              "descendants" : {
                "attachment" : {
                  "size" : "Required integer",
                  "_links" : "Required object",
                  "start" : "Required integer",
                  "limit" : "Required integer",
                  "results" : [ "Content" ]
                },
                "_links" : "Required object",
                "comment" : {
                  "size" : "Required integer",
                  "_links" : "Required object",
                  "start" : "Required integer",
                  "limit" : "Required integer",
                  "results" : [ "Content" ]
                },
                "page" : {
                  "size" : "Required integer",
                  "_links" : "Required object",
                  "start" : "Required integer",
                  "limit" : "Required integer",
                  "results" : [ "Content" ]
                },
                "_expandable" : {
                  "attachment" : "string",
                  "comment" : "string",
                  "page" : "string"
                }
              },
              "space" : "Space",
              "childTypes" : {
                "attachment" : {
                  "_links" : "Required object",
                  "value" : "Required boolean"
                },
                "comment" : {
                  "_links" : "Required object",
                  "value" : "Required boolean"
                },
                "page" : {
                  "_links" : "Required object",
                  "value" : "Required boolean"
                },
                "_expandable" : {
                  "all" : "string",
                  "attachment" : "string",
                  "comment" : "string",
                  "page" : "string"
                }
              },
              "operations" : [ {
                "targetType" : "The space or content type that the operation applies to.",
                "operation" : "The operation itself."
              } ],
              "children" : {
                "attachment" : {
                  "size" : "Required integer",
                  "_links" : "Required object",
                  "start" : "Required integer",
                  "limit" : "Required integer",
                  "results" : [ "Content" ]
                },
                "_links" : "Required object",
                "comment" : {
                  "size" : "Required integer",
                  "_links" : "Required object",
                  "start" : "Required integer",
                  "limit" : "Required integer",
                  "results" : [ "Content" ]
                },
                "page" : {
                  "size" : "Required integer",
                  "_links" : "Required object",
                  "start" : "Required integer",
                  "limit" : "Required integer",
                  "results" : [ "Content" ]
                },
                "_expandable" : {
                  "attachment" : "string",
                  "comment" : "string",
                  "page" : "string"
                }
              },
              "id" : "Required string",
              "ancestors" : [ "Content" ],
              "_expandable" : {
                "childTypes" : "string",
                "container" : "string",
                "metadata" : "string",
                "operations" : "string",
                "children" : "string",
                "restrictions" : "string",
                "history" : "string",
                "ancestors" : "string",
                "body" : "string",
                "version" : "string",
                "descendants" : "string",
                "space" : "string"
              },
              "status" : "Required string"
            },
            "status" : "Required string"
          }
        } ]
      },
      "group" : {
        "size" : "Required integer",
        "results" : [ {
          "_links" : "Required object",
          "name" : "Required string",
          "type" : "Required string. Possible values: group"
        } ]
      }
    },
    "operation" : {
      "targetType" : "The space or content type that the operation applies to.",
      "operation" : "The operation itself."
    },
    "unlicensedAccess" : "Grants access to unlicensed users from JIRA Service Desk when used\nwith the 'read space' operation."
  } ],
  "name" : "The name of the new space.",
  "description" : {
    "plain" : {
      "value" : "The space description.",
      "representation" : "Set to 'plain'."
    }
  },
  "key" : "The key for the new space. Format: See [Space\nkeys](https://confluence.atlassian.com/x/lqNMMQ)."
}

id (required)#

The ID of the content to be deleted.

Type: string

status#

Set this to trashed, if the content's status is trashed and you want to purge it.

Type: string

id (required)#

The ID of the content that the property belongs to.

Type: string

key (required)#

The key of the property.

Type: string

key (required)#

The key of the property to be deleted.

Type: string

spaceKey (required)#

The key of the space that the property is in.

Type: string

relationName (required)#

The name of the relationship.

Type: string

sourceKey (required)#

• The identifier for the source entity:

• If sourceType is 'user', then specify either 'current' (logged-in
  user) or the user key.

• If sourceType is 'content', then specify the content ID.

• If sourceType is 'space', then specify the space key.

Type: string

sourceType (required)#

The source entity type of the relationship. This must be 'user', if
the relationName is 'favourite'.

Type: string

Potential values: user, content, space

targetKey (required)#

• The identifier for the target entity:

• If sourceType is 'user', then specify either 'current' (logged-in
  user) or the user key.

• If sourceType is 'content', then specify the content ID.

• If sourceType is 'space', then specify the space key.

Type: string

targetType (required)#

The target entity type of the relationship. This must be 'space' or
'content', if the relationName is 'favourite'.

Type: string

Potential values: user, content, space

sourceStatus#

The status of the source. This parameter is only used when the
sourceType is 'content'.

Type: string

sourceVersion#

The version of the source. This parameter is only used when the
sourceType is 'content' and the sourceStatus is 'historical'.

Type: integer

targetStatus#

The status of the target. This parameter is only used when the
targetType is 'content'.

Type: string

targetVersion#

The version of the target. This parameter is only used when the
targetType is 'content' and the targetStatus is 'historical'.

Type: integer

id (required)#

The ID of the content to remove restrictions from.

Type: string

expand#

A multi-value parameter indicating which properties of the content
restrictions (returned in response) to expand.

• restrictions.user returns the piece of content that the restrictions are
  applied to. Expanded by default.
• restrictions.group returns the piece of content that the restrictions are
  applied to. Expanded by default.
• content returns the piece of content that the restrictions are
  applied to.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

spaceKey (required)#

The key of the space to delete.

Type: string

id (required)#

The ID of the content that the version will be deleted from.

Type: string

versionNumber (required)#

The number of the version to be deleted. The version number starts
from 1 up to current version.

Type: integer

endDate#

Filters the exported results to the records on or before the endDate.
The endDate must be specified as a timestamp.

Type: string

format#

The format of the export file for the audit records.

Type: string

Potential values: csv, zip

searchString#

Filters the exported results to records that have string property values
matching the searchString.

Type: string

startDate#

Filters the exported results to the records on or after the startDate.
The startDate must be specified as a timestamp.

Type: string

relationName (required)#

The name of the relationship. This method supports relationships created via
Create relationship.
Note, this method does not support 'favourite' relationships.

Type: string

sourceType (required)#

The source entity type of the relationship.

Type: string

Potential values: user, content, space

targetKey (required)#

The identifier for the target entity:

• If targetType is user, then specify either current (logged-in user), the user key of the user, or
  the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
  migration guide
  for details.
• If targetType is 'content', then specify the content ID.
• If targetType is 'space', then specify the space key.

Type: string

targetType (required)#

The target entity type of the relationship.

Type: string

Potential values: user, content, space

expand#

A multi-value parameter indicating which properties of the response
object to expand.

• relationData returns information about the relationship, such as
  who created it and when it was created.
• source returns the source entity.
• target returns the target entity.

Type: array

[ "string. Possible values: relationData | source | target" ]

sourceStatus#

The status of the source. This parameter is only used when the
sourceType is 'content'.

Type: string

sourceVersion#

The version of the source. This parameter is only used when the
sourceType is 'content' and the sourceStatus is 'historical'.

Type: integer

targetStatus#

The status of the target. This parameter is only used when the
targetType is 'content'.

Type: string

targetVersion#

The version of the target. This parameter is only used when the
targetType is 'content' and the targetStatus is 'historical'.

Type: integer

relationName (required)#

The name of the relationship. This method supports relationships created via
Create relationship.
Note, this method does not support 'favourite' relationships.

Type: string

sourceKey (required)#

The identifier for the source entity:

• If sourceType is user, then specify either current (logged-in user), the user key of the user, or
  the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
  migration guide
  for details.
• If sourceType is 'content', then specify the content ID.
• If sourceType is 'space', then specify the space key.

Type: string

sourceType (required)#

The source entity type of the relationship.

Type: string

Potential values: user, content, space

targetType (required)#

The target entity type of the relationship.

Type: string

Potential values: user, content, space

expand#

A multi-value parameter indicating which properties of the response
object to expand.

• relationData returns information about the relationship, such as
  who created it and when it was created.
• source returns the source entity.
• target returns the target entity.

Type: array

[ "string. Possible values: relationData | source | target" ]

sourceStatus#

The status of the source. This parameter is only used when the
sourceType is 'content'.

Type: string

sourceVersion#

The version of the source. This parameter is only used when the
sourceType is 'content' and the sourceStatus is 'historical'.

Type: integer

targetStatus#

The status of the target. This parameter is only used when the
targetType is 'content'.

Type: string

targetVersion#

The version of the target. This parameter is only used when the
targetType is 'content' and the targetStatus is 'historical'.

Type: integer

expand#

A multi-value parameter indicating which properties of the user to
expand.

• operations returns the operations that the user is allowed to do.

Type: array

[ "string. Possible values: operations" ]

key#

The key of a user. To specify multiple users, pass multiple key parameters separated by ampersands.
For example, key=mia&key=alana. Required if username isn't provided. Cannot be provided if username is present.

Type: array

[ "string" ]

username#

The username of a user. To specify multiple users, pass multiple username parameters separated by ampersands.
For example, username=mia&username=alana. Required if key isn't provided. Cannot be provided if key is present.

Type: array

[ "string" ]

accountId (required)#

The account IDs of the users.

Type: array

[ "string" ]

accountId (required)#

A list of accountId's of users to be returned.

Type: string

expand#

A multi-value parameter indicating which properties of the user to
expand.

• operations returns the operations that the user is allowed to do.
• details.personal returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.
  Note that these fields have been deprecated due to privacy changes. See the
  migration guide
  for details.
• details.business returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.
  Note that these fields have been deprecated due to privacy changes. See the
  migration guide
  for details.
• personalSpace returns the user's personal space, if it exists.

Type: array

[ "string. Possible values: operations | details.personal | details.business | personalSpace" ]

id (required)#

The ID of the content to be returned. If you don't know the content ID,
use Get content and filter the results.

Type: string

embeddedContentRender#

The version of embedded content (e.g. attachments) to render.

• current renders the latest version of the embedded content.
• version-at-save renders the version of the embedded content
  at the time of save.

Type: string

Potential values: current, version-at-save

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

status#

Filter the results to a set of content based on their status.
If set to any, content with any status is returned. Note, the
historical status is currently not supported.

Type: array

[ "string. Possible values: current | trashed | draft | any" ]

trigger#

If set to viewed, the request will trigger a 'viewed' event for the content.
When this event is triggered, the page/blogpost will appear on the 'Recently visited'
tab of the user's Confluence dashboard.

Type: string

Potential values: viewed

version#

The version number of the content to be returned.

Type: integer

spaceKey (required)#

The key of the space to be queried for its content.

Type: string

type (required)#

The type of content to return.

Type: string

Potential values: page, blogpost

depth#

Filter the results to content at the root level of the space or all
content.

Type: string

Potential values: all, root

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

spaceKey (required)#

The key of the space to be queried for its content.

Type: string

depth#

Filter the results to content at the root level of the space or all content.

Type: string

Potential values: all, root

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

groupName (required)#

The name of the group to be queried for whether the content restriction
applies to it.

Type: string

id (required)#

The ID of the content that the restriction applies to.

Type: string

operationKey (required)#

The operation that the restriction applies to.

Type: string

Potential values: read, update

id (required)#

The ID of the content that the restriction applies to.

Type: string

operationKey (required)#

The operation that is restricted.

Type: string

accountId#

The account ID of the user to be queried for whether the content restriction applies to it. The accountId
uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether the content restriction applies to it.
Required, unless the username or accountId is specified.

Type: string

userName#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether the content restriction applies to it.
Required, unless the key or accountId is specified.

Type: string

contentTemplateId (required)#

The ID of the content template to be returned.

Type: string

contentId (required)#

The ID of the content to be queried for whether the specified user is
watching it.

Type: string

accountId#

The accountId of the user to be queried for whether they are watching the content. The accountId uniquely
identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether they are watching the
content. Required, unless the username or accountId is specified.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether they are watching
the content. Required, unless the key or accountId is specified.

Type: string

expand#

A multi-value parameter indicating which properties of the user to
expand.

• operations returns the operations that the user is allowed to do.
• details.personal returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.
  Note that these fields have been deprecated due to privacy changes. See the
  migration guide
  for details.
• details.business returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.
  Note that these fields have been deprecated due to privacy changes. See the
  migration guide
  for details.
• personalSpace returns the user's personal space, if it exists.

Type: array

[ "string. Possible values: operations | details.personal | details.business | personalSpace" ]

groupName (required)#

The name of the group. This is the same as the group name shown in
the Confluence administration console.

Type: string

id (required)#

The ID of the content to be queried for its history.

Type: string

expand#

A multi-value parameter indicating which properties of the content history to expand.

• lastUpdated returns information about the most recent update of the content,
  including who updated it and when it was updated.
• previousVersion returns information about the update prior to the current content
  update. For this method, it contains the same information as lastUpdated.
• contributors returns all of the users who have contributed to the content.
• nextVersion This parameter is not used for this method.

Type: array

[ "string. Possible values: lastUpdated | previousVersion | contributors | nextVersion" ]

spaceKey#

The key of the space for which the look and feel settings will be
returned. If this is not set, only the global look and feel settings
are returned.

Type: string

id (required)#

The ID for the content that contains the macro.

Type: string

macroId (required)#

The ID of the macro. This is usually passed by the app that the
macro is in. Otherwise, find the macro ID by querying the desired
content and version, then expanding the body in storage format.
For example, '/content/196611/version/7?expand=content.body.storage'.

Type: string

version (required)#

The version of the content that contains the macro.

Type: integer

accountId (required)#

The account ID of the user, which uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

Type: string

id (required)#

The ID of the content to be queried for the property.

Type: string

key (required)#

The key of the content property.

Type: string

expand#

A multi-value parameter indicating which properties of the content to
expand. By default, the version object is expanded.

• content returns the content that the property is stored against.
• version returns information about the version of the property, such
  as the version number, when it was created, etc.

Type: array

[ "string. Possible values: content | version" ]

key (required)#

The key of the space property.

Type: string

spaceKey (required)#

The key of the space that the property is in.

Type: string

expand#

A multi-value parameter indicating which properties of the space
property to expand. By default, the version object is expanded.

• version returns information about the version of the content.
• space returns the space that the properties are in.

Type: array

[ "string. Possible values: version | space" ]

relationName (required)#

The name of the relationship. This method supports the 'favourite'
(i.e. 'save for later') relationship as well as any other relationship
types created via Create relationship.

Type: string

sourceKey (required)#

• The identifier for the source entity:

• If sourceType is user, then specify either current (logged-in user), the user key of the user, or
  the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
  migration guide
  for details.

• If sourceType is 'content', then specify the content ID.

• If sourceType is 'space', then specify the space key.

Type: string

sourceType (required)#

The source entity type of the relationship. This must be 'user', if
the relationName is 'favourite'.

Type: string

Potential values: user, content, space

targetKey (required)#

The identifier for the target entity:

• If targetType is user, then specify either current (logged-in user), the user key of the user, or
  the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
  migration guide
  for details.
• If targetType is 'content', then specify the content ID.
• If targetType is 'space', then specify the space key.

Type: string

targetType (required)#

The target entity type of the relationship. This must be 'space' or
'content', if the relationName is 'favourite'.

Type: string

Potential values: user, content, space

expand#

A multi-value parameter indicating which properties of the response
object to expand.

• relationData returns information about the relationship, such as
  who created it and when it was created.
• source returns the source entity.
• target returns the target entity.

Type: array

[ "string. Possible values: relationData | source | target" ]

sourceStatus#

The status of the source. This parameter is only used when the
sourceType is 'content'.

Type: string

sourceVersion#

The version of the source. This parameter is only used when the
sourceType is 'content' and the sourceStatus is 'historical'.

Type: integer

targetStatus#

The status of the target. This parameter is only used when the
targetType is 'content'.

Type: string

targetVersion#

The version of the target. This parameter is only used when the
targetType is 'content' and the targetStatus is 'historical'.

Type: integer

spaceKey (required)#

The key of the space to be returned.

Type: string

expand#

A multi-value parameter indicating which properties of the spaces to
expand, where:

• settings returns the settings for the space, similar to Get space settings.
• metadata.labels returns the space labels, which are used to categorize the space.
• operations returns the operations for a space, which are used when setting permissions.
• lookAndFeel returns information about the look and feel of the space, including the color scheme.
• permissions returns the permissions for the space. Note that this may return permissions for deleted groups,
  because deleting a group doesn't remove associated space permissions.
• icon returns information about space icon.
• description.plain returns the description of the space.
• description.view returns the description of the space.
• theme returns information about the space theme.
• homepage returns information about the space homepage.

Type: array

[ "string. Possible values: settings | metadata.labels | operations | lookAndFeel | permissions | icon | description.plain | description.view | theme | homepage" ]

id (required)#

The ID of the task.

Type: string

themeKey (required)#

The key of the theme to be returned.

Type: string

spaceKey (required)#

The key of the space to be queried for its theme.

Type: string

accountId#

The account ID of the user, which uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

expand#

A multi-value parameter indicating which properties of the user to
expand.

• operations returns the operations that the user is allowed to do.
• details.personal returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.
  Note that these fields have been deprecated due to privacy changes. See the
  migration guide
  for details.
• details.business returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.
  Note that these fields have been deprecated due to privacy changes. See the
  migration guide
  for details.
• personalSpace returns the user's personal space, if it exists.

Type: array

[ "string. Possible values: operations | details.personal | details.business | personalSpace" ]

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The userKey of the user to be returned. Required, unless the
username or accountId is specified. The key uniquely identifies
a user in a Confluence instance and does not change.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be returned. Required, unless the key
or accountId is specified. The username uniquely identifies a
user in a Confluence instance but can change if the user is renamed.

Type: string

id (required)#

The ID of the content to be queried for its version.

Type: string

versionNumber (required)#

The number of the version to be retrieved.

Type: integer

expand#

A multi-value parameter indicating which properties of the content to
expand. By default, the content object is expanded.

• collaborators returns the users that collaborated on the version.
• content returns the content for the version.

Type: array

[ "string. Possible values: collaborators | content" ]

labelName (required)#

The name of the label to be queried for whether the specified user is
watching it.

Type: string

accountId#

The accountId of the user to be queried for whether they are watching the label. The accountId uniquely identifies
the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether they are watching the label. Required, unless the username or accountId is specified.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether they are watching the label. Required, unless the key or accountId is specified.

Type: string

spaceKey (required)#

The key of the space to be queried for whether the specified user is
watching it.

Type: string

accountId#

The accountId of the user to be queried for whether they are watching the space. The accountId uniquely identifies
the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether they are watching the space. Required, unless the username or accountId is specified.

Type: string

username#

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether they are watching the space. Required, unless the key or accountId is specified.

Type: string

id (required)#

The ID of the content to be queried for its descendants.

Type: string

type (required)#

The type of descendants to return.

Type: string

Potential values: page, comment, attachment

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

id (required)#

The ID of the content to be queried for its attachments.

Type: string

expand#

A 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 information
  returned 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 favourite.
• 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 that
  this 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 that
  this 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, including
  who 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 it
  and 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 by
  Get space.