Skip to content

GET /user

Get User List

GET
/user

Return a list of users, optionally filtered to active accounts.

Executes Queries.GET_USER_LIST with the active_only flag. Each result
is a UserListItem that includes department details and login state. Pass
active_only=false to include archived/disabled accounts.

Emits: (direct transaction — no event class)

Required scope: org:user:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

active_only
Type
boolean
Default
true

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.