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

• BearerAuth
• ApiKeyAuth

Parameters

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

200

List of users

Media type application/json

object

pagination

object

limit

integer

offset

integer

total

integer

users

Array<object>

object

active

boolean

createdAt

string

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": "example",
      "displayName": "example",
      "email": "example",
      "emailVerified": true,
      "familyName": "example",
      "givenName": "example",
      "id": "example",
      "isServiceAccount": true,
      "pictureUrl": "example",
      "username": "example"
    }
  ]
}

400

Bad request - Invalid active filter

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - requires Organization Owner role

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}