The Confluence Cloud REST API

Content watches

Get watches for 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).

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

id Required

string

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

Query parameters

start

integer

The starting index of the returned watches.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/content/{id}/notification/child-created' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

Returned if the requested watches are returned.

Content type	Value
application/json	WatchArray

Get watches for space

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).

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

id Required

string

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

Query parameters

start

integer

The starting index of the returned watches.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/content/{id}/notification/created' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

Returned if the requested watches are returned.

Content type	Value
application/json	WatchArray

Get space watchers

GET /wiki/rest/api/space/{spaceKey}/watch

Returns a list of watchers of a space

Connect app scope required: READ

Request

Path parameters

spaceKey Required

string

The key of the space to get watchers.

Query parameters

start

string

The start point of the collection to return.

limit

string

The limit of the number of items to return, this may be restricted by fixed system limits.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/space/{spaceKey}/watch' \
  --header 'Accept: application/json'

Responses

200

404

Returned if watchers list is returned.

Content type	Value
application/json	SpaceWatchArray

Get content watch status

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:

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 if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

contentId Required

string

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

Query parameters

accountId Required

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.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/content/{contentId}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

403

404

Returned if the requested watch status is returned.

Content type	Value
application/json	UserWatch

Add content watcher

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:

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 required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-content

Request

Path parameters

contentId Required

string

The ID of the content to add the watcher to.

Query parameters

accountId Required

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.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request POST \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/content/{contentId}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the watcher was successfully created. No response body is returned.

A schema has not been defined for this response code.

Remove content watcher

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:

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 if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: DELETE

OAuth scopes required:

write:confluence-content

Request

Path parameters

contentId Required

string

The ID of the content to remove the watcher from.

Query parameters

accountId Required

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.

Header parameters

X-Atlassian-Token Required

string

Note, you must add header when making a request, as this operation has XSRF protection.

Default: no-check

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/content/{contentId}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the watcher was successfully deleted. No response body is returned.

A schema has not been defined for this response code.

Get label watch status

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:

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 if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

labelName Required

string

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

Query parameters

accountId Required

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.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/label/{labelName}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

403

404

Returned if the requested watch status is returned.

Content type	Value
application/json	UserWatch

Add label watcher

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:

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 required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-content

Request

Path parameters

labelName Required

string

The name of the label to add the watcher to.

Query parameters

accountId Required

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.

Header parameters

X-Atlassian-Token Required

string

Note, you must add header when making a request, as this operation has XSRF protection.

Default: no-check

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request POST \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/label/{labelName}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the watcher was successfully created. No response body is returned.

A schema has not been defined for this response code.

Remove label watcher

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:

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 if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: DELETE

OAuth scopes required:

write:confluence-content

Request

Path parameters

labelName Required

string

The name of the label to remove the watcher from.

Query parameters

accountId Required

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.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/label/{labelName}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the watcher was successfully deleted. No response body is returned.

A schema has not been defined for this response code.

Get space watch status

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:

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 if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

spaceKey Required

string

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

Query parameters

accountId Required

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.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/space/{spaceKey}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

403

404

Returned if the requested watch status is returned.

Content type	Value
application/json	UserWatch

Add space watcher

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:

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 required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-content

Request

Path parameters

spaceKey Required

string

The key of the space to add the watcher to.

Query parameters

accountId Required

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.

Header parameters

X-Atlassian-Token Required

string

Note, you must add header when making a request, as this operation has XSRF protection.

Default: no-check

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request POST \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/space/{spaceKey}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the watcher was successfully created. No response body is returned.

A schema has not been defined for this response code.

Remove space watch

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:

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 if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: DELETE

OAuth scopes required:

write:confluence-content

Request

Path parameters

spaceKey Required

string

The key of the space to remove the watcher from.

Query parameters

accountId Required

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.

Example

cURL

Node.js

Java

Python

PHP

Forge

Connect

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/user/watch/space/{spaceKey}?accountId={accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the watcher was successfully deleted. No response body is returned.

A schema has not been defined for this response code.