v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB

Content watches

Get space watch status

Returns whether a user is watching a space. Choose the user by doing one of the following:

Specify a user via a query parameter: Use the accountId to identify the user.
Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission or 'Space Administrator' permission for the relevant space if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

get/wiki/rest/api/user/watch/space/{spaceKey}

Path parameters

spaceKeystring required

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

Query parameters

keystring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

usernamestring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

accountIdstring

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

Response

Returned if the requested watch status is returned.

watchingboolean required