Space Watchers

Postman Collection

OpenAPI

Operations

GET/rest/api/space/{spaceKey}/watchers

GET

Fetch users watching space

Returns a paginated list of users watching the given Space identified by spaceKey. Only a Confluence Administrator or Space Administrator can perform this action.

Request

Path parameters

spaceKey

string

Required

Query parameters

limit

integer

start

integer

Responses

returns a paginated list of users watching the given Space identified by spaceKey

application/json

object

GET/rest/api/space/{spaceKey}/watchers

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/watchers' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "profilePicture": {
        "path": "http://www.example.com/path/to/image.png",
        "width": 16,
        "height": 16,
        "isDefault": true
      },
      "displayName": "Joe Smith",
      "username": "user1",
      "userKey": "userkey[admin]"
    }
  ],
  "start": 25,
  "limit": 25,
  "size": 25,
  "_links": {
    "base": "http://localhost:8085/rest/api",
    "self": "http://localhost:8085/rest/api",
    "context": "http://localhost:8085/rest/api",
    "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
    "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0"
  }
}