Rate this page:
GET /wiki/rest/api/content/{id}/notification/child-created
Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.
If you want to manage watches for a page, use the following user methods:
Permissions required: Permission to access the Confluence site ('Can use' global permission).
App scope required: READ
read:confluence-content.summarystring
The ID of the content to be queried for its watches.
integer
The starting index of the returned watches.
0, Minimum: 0, Format: int32integer
The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.
200, Minimum: 0, Format: int321 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/notification/child-created' \
--header 'Accept: application/json'Returned if the requested watches are returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/content/{id}/notification/created
Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated.
If you want to manage watches for a space, use the following user methods:
Permissions required: Permission to access the Confluence site ('Can use' global permission).
App scope required: READ
read:confluence-content.summarystring
The ID of the content to be queried for its watches.
integer
The starting index of the returned watches.
0, Minimum: 0, Format: int32integer
The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.
200, Minimum: 0, Format: int321 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/notification/created' \
--header 'Accept: application/json'Returned if the requested watches are returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/space/{spaceKey}/watch
Returns a list of watchers of a space
App scope required: READ
string
The key of the space to get watchers.
string
The start point of the collection to return.
string
The limit of the number of items to return, this may be restricted by fixed system limits.
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/watch' \
--header 'Accept: application/json'Returned if watchers list is returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/user/watch/content/{contentId}
Returns whether a user is watching a piece of content. Choose the user by doing one of the following:
accountId to identify the user.Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: READ
read:confluence-content.summarystring
The ID of the content to be queried for whether the specified user is watching it.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
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.
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/content/{contentId}?accountId={accountId}' \
--header 'Accept: application/json'Returned if the requested watch status is returned.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/user/watch/content/{contentId}
Adds a user as a watcher to a piece of content. Choose the user by doing one of the following:
accountId to identify the user.Note, you must add the X-Atlassian-Token: no-check header when making a
request, as this operation has XSRF protection.
Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: WRITE
write:confluence-contentstring
The ID of the content to add the watcher to.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
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.
1 2
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/content/{contentId}?accountId={accountId}'Returned if the watcher was successfully created. No response body is returned.
DELETE /wiki/rest/api/user/watch/content/{contentId}
Removes a user as a watcher from a piece of content. Choose the user by doing one of the following:
accountId to identify the user.Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: DELETE
write:confluence-contentstring
The ID of the content to remove the watcher from.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
The accountId of the user to be removed as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/content/{contentId}?accountId={accountId}'Returned if the watcher was successfully deleted. No response body is returned.
GET /wiki/rest/api/user/watch/label/{labelName}
Returns whether a user is watching a label. Choose the user by doing one of the following:
accountId to identify the user.Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: READ
read:confluence-content.summarystring
The name of the label to be queried for whether the specified user is watching it.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
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.
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/label/{labelName}?accountId={accountId}' \
--header 'Accept: application/json'Returned if the requested watch status is returned.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/user/watch/label/{labelName}
Adds a user as a watcher to a label. Choose the user by doing one of the following:
accountId to identify the user.Note, you must add the X-Atlassian-Token: no-check header when making a
request, as this operation has XSRF protection.
Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: WRITE
write:confluence-contentstring
The name of the label to add the watcher to.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
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.
1 2
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/label/{labelName}?accountId={accountId}'Returned if the watcher was successfully created. No response body is returned.
DELETE /wiki/rest/api/user/watch/label/{labelName}
Removes a user as a watcher from a label. Choose the user by doing one of the following:
accountId to identify the user.Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: DELETE
write:confluence-contentstring
The name of the label to remove the watcher from.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
The accountId of the user to be removed as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/label/{labelName}?accountId={accountId}'Returned if the watcher was successfully deleted. No response body is returned.
GET /wiki/rest/api/user/watch/space/{spaceKey}
Returns whether a user is watching a space. Choose the user by doing one of the following:
accountId to identify the user.Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: READ
read:confluence-content.summarystring
The key of the space to be queried for whether the specified user is watching it.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
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.
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/space/{spaceKey}?accountId={accountId}' \
--header 'Accept: application/json'Returned if the requested watch status is returned.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/user/watch/space/{spaceKey}
Adds a user as a watcher to a space. Choose the user by doing one of the following:
accountId to identify the user.Note, you must add the X-Atlassian-Token: no-check header when making a
request, as this operation has XSRF protection.
Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: WRITE
write:confluence-contentstring
The key of the space to add the watcher to.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
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.
1 2
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/space/{spaceKey}?accountId={accountId}'Returned if the watcher was successfully created. No response body is returned.
DELETE /wiki/rest/api/user/watch/space/{spaceKey}
Removes a user as a watcher from a space. Choose the user by doing one of the following:
accountId to identify the user.Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
App scope required: DELETE
write:confluence-contentstring
The key of the space to remove the watcher from.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
This parameter is no longer available and will be removed from the documentation soon.
Use accountId instead.
See the deprecation notice for details.
string
The accountId of the user to be removed as a watcher. The accountId uniquely identifies the user across all
Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/space/{spaceKey}?accountId={accountId}'Returned if the watcher was successfully deleted. No response body is returned.
Rate this page: