Skip to content
BookendBookend Docs

List users

GET
/v1/users
curl --request GET \
  --url http://localhost:8080/v1/users

Paged list of users with their roles (page 1-based, size up to 200, default 50) in the { items, page, size, total } envelope. Administrators only.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
size
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Page envelope: { items, page, size, total }.

object
items
required
Array<object>
object
id
required
string format: uuid
email
required
string
displayName
required
string
roles
required
Array<string>
isActive
required
boolean
lastLoginAt
required
null | string format: date-time
totpEnrolled
required
boolean
page
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
size
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
total
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasNext
boolean
Examplegenerated
{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "email": "example",
      "displayName": "example",
      "roles": [
        "example"
      ],
      "isActive": true,
      "lastLoginAt": "2026-04-15T12:00:00Z",
      "totpEnrolled": true
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "hasNext": true
}