List Users — GET /api/v1/users
List Users
List all users (paginated). Requires QA_LEAD or higher.
Endpoint: GET /api/v1/users
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA lead or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
is_active | query | no | boolean or null | ||
role | query | no | UserRole or null | ||
q | query | no | string or null | Case-insensitive substring of the username, email or full name (ADM-03). | |
page | query | no | integer | 1 | Page number |
page_size | query | no | integer | 50 | Items per page |
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | array of UserListResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: User Management
- Operation ID:
list_users_api_v1_users_get - Source code:
backend/app/routers/users.py, line 131 - Specification: OpenAPI JSON