Admin Users

Postman Collection

OpenAPI

Operations

GET/rest/api/admin/users/list/active

GET

Get active users

Gets a paginated collection of all active users (users which count into license usage). This will exclude users that are:

anonymous,
deactivated,
externally deleted,
shadowed
unlicensed

This feature relies on search index and might not be accurate when site reindex is in progress.

Example request URI(s): http://example.com/confluence/rest/api/admin/users/list/active http://example.com/confluence/rest/api/admin/users/list/active?start=0 http://example.com/confluence/rest/api/admin/users/list/active?start=0&limit=100 http://example.com/confluence/rest/api/admin/users/list/active?start=0&limit=100&expand=status

Request

Query parameters

expand

string

limit

string

start

string

Responses

returns a paginated collection of users.

application/json

object

GET/rest/api/admin/users/list/active

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/admin/users/list/active' \
  --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",
      "type": "<string>"
    }
  ],
  "totalCount": 2154,
  "start": 25,
  "limit": 25,
  "size": 25,
  "_links": {
    "base": "http://localhost:8085/confluence",
    "context": "confluence",
    "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
    "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
    "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
  }
}