{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Content Watches API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Content Watches", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Space Watchers", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/space/:spaceKey/watch", "params": [ { "name": "spaceKey", "value": "", "type": "path", "description": "The key of the space to get watchers." }, { "name": "start", "value": "", "type": "query", "description": "The start point of the collection to return." }, { "name": "limit", "value": "", "type": "query", "description": "The limit of the number of items to return, this may be restricted by fixed system limits." } ] }, "docs": "Returns a list of watchers of a space" }, { "info": { "name": "Atlassian Get Content Watch Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/content/:contentId", "params": [ { "name": "contentId", "value": "", "type": "path", "description": "The ID of the content to be queried for whether the specified user is\nwatching it." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Returns whether a user is watching a piece of content. 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](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Add Content Watcher", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/content/:contentId", "params": [ { "name": "contentId", "value": "", "type": "path", "description": "The ID of the content to add the watcher to." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Adds a user as a watcher to a piece of content. 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.

Note, you must add the `X-Atlassian-Token: no-check` header when making a
request, as this operation has XSRF protection.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' gl" }, { "info": { "name": "Atlassian Remove Content Watcher", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/content/:contentId", "headers": [ { "name": "X-Atlassian-Token", "value": "" } ], "params": [ { "name": "contentId", "value": "", "type": "path", "description": "The ID of the content to remove the watcher from." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Removes a user as a watcher from a piece of content. 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](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get Label Watch Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/label/:labelName", "params": [ { "name": "labelName", "value": "", "type": "path", "description": "The name of the label to be queried for whether the specified user is\nwatching it." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Returns whether a user is watching a label. 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](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Add Label Watcher", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/label/:labelName", "headers": [ { "name": "X-Atlassian-Token", "value": "" } ], "params": [ { "name": "labelName", "value": "", "type": "path", "description": "The name of the label to add the watcher to." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Adds a user as a watcher to a label. 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.

Note, you must add the `X-Atlassian-Token: no-check` header when making a
request, as this operation has XSRF protection.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permis" }, { "info": { "name": "Atlassian Remove Label Watcher", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/label/:labelName", "params": [ { "name": "labelName", "value": "", "type": "path", "description": "The name of the label to remove the watcher from." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Removes a user as a watcher from a label. 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](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get Space Watch Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/space/:spaceKey", "params": [ { "name": "spaceKey", "value": "", "type": "path", "description": "The key of the space to be queried for whether the specified user is\nwatching it." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "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](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Add Space Watcher", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/space/:spaceKey", "headers": [ { "name": "X-Atlassian-Token", "value": "" } ], "params": [ { "name": "spaceKey", "value": "", "type": "path", "description": "The key of the space to add the watcher to." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Adds a user as a watcher to 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.

Note, you must add the `X-Atlassian-Token: no-check` header when making a
request, as this operation has XSRF protection.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permis" }, { "info": { "name": "Atlassian Remove Space Watch", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/user/watch/space/:spaceKey", "params": [ { "name": "spaceKey", "value": "", "type": "path", "description": "The key of the space to remove the watcher from." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Removes a user as a watcher from 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](https://confluence.atlassian.com/x/_AozKw) required**:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get Watches For Page", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/notification/child-created", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its watches." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned watches." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of watches to return per page.\nNote, this may be restricted by fixed system limits." } ] }, "docs": "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:

- [Get content watch status for user](#api-user-watch-content-contentId-get)
- [Add content watch](#api-user-watch-content-contentId-post)
- [Remove content watch](#api-user-watch-content-contentId-delete)

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required*" }, { "info": { "name": "Atlassian Get Watches For Space", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/notification/created", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its watches." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned watches." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of watches to return per page.\nNote, this may be restricted by fixed system limits." } ] }, "docs": "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:

- [Get space watch status for user](#api-user-watch-space-spaceKey-get)
- [Add space watch](#api-user-watch-space-spaceKey-post)
- [Remove space watch](#api-user-watch-space-spaceKey-delete)

**[Permissions](https://conflu" } ] } ], "bundled": true }