Skip to content
Governance Platform

List platform users

GET
/api/v1/users
 
curl --request GET \
  --url https://localhost:8080/api/v1/users \
  --header 'Authorization: <Authorization>'

Return a paginated list of platform users, optionally filtered by active status; restricted to organization owners

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer

Number of users to return (default: 100, max: 500)

offset
integer

Number of users to skip

active
boolean

Filter by active status

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of users

Media type application/json

A page of platform users, with the pagination window it was built from

object
pagination

The limit and offset slice a list response was built from, with the total available

object
limit
integer
offset
integer
total
integer
users
Array<object>

A platform user as returned by the listing endpoints

object
active
boolean
createdAt
string format: date-time
displayName
string
email
string
emailVerified
boolean
familyName
string
givenName
string
id
string
isServiceAccount
boolean
pictureUrl
string
username
string
Example generated
{
  "pagination": {
    "limit": 1,
    "offset": 1
  },
  "total": 1,
  "users": [
    {
      "active": true,
      "createdAt": "2026-04-15T12:00:00Z",
      "displayName": "example",
      "email": "example",
      "emailVerified": true,
      "familyName": "example",
      "givenName": "example",
      "id": "example",
      "isServiceAccount": true,
      "pictureUrl": "example",
      "username": "example"
    }
  ]
}

400

Section titled “400 ”

Bad request - Invalid active filter

Media type application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object
error
string
error_description
string
Example 
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Section titled “401 ”

Unauthorized

Media type application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object
error
string
error_description
string
Example 
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Section titled “403 ”

Forbidden - requires Organization Owner role

Media type application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object
error
string
error_description
string
Example 
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Section titled “500 ”

Internal server error

Media type application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object
error
string
error_description
string
Example 
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}