Users
Users endpoints of the bizSupply API.
Last updated: 2026-07-21
GET /api/v1/users
List users within the current tenant (OWNER or ADMIN only).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
pageable | query | yes |
Responses
| Status | Description |
|---|---|
200 | Paginated list of users |
403 | Insufficient role |
POST /api/v1/users
Create a new user within the current tenant (OWNER or ADMIN only).
Request body
application/json→CreateUserRequest
Responses
| Status | Description |
|---|---|
200 | Created user profile |
400 | Invalid request body |
403 | Insufficient role |
GET /api/v1/users/me
Get the current authenticated user's profile.
Responses
| Status | Description |
|---|---|
200 | User profile |
401 | Authentication required |
PUT /api/v1/users/me
Update the current authenticated user's profile.
Request body
application/json→UserUpdateRequest
Responses
| Status | Description |
|---|---|
200 | Updated user profile |
400 | Invalid request body |
401 | Authentication required |
GET /api/v1/users/me/organizations
List the current user's organization memberships.
Responses
| Status | Description |
|---|---|
200 | List of memberships |
401 | Authentication required |
GET /api/v1/users/{id}
Get a user by ID within the current tenant.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | User UUID. |
Responses
| Status | Description |
|---|---|
200 | User profile |
403 | Insufficient role |
404 | User not found in this tenant |
PUT /api/v1/users/{id}
Update a user by ID (OWNER or ADMIN only).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | User UUID. |
Request body
application/json→UpdateUserRequest
Responses
| Status | Description |
|---|---|
200 | Updated user profile |
403 | Insufficient role |
404 | User not found |
DELETE /api/v1/users/{id}
Soft-delete a user by ID (OWNER or ADMIN only).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | User UUID. |
Responses
| Status | Description |
|---|---|
204 | User deleted |
403 | Insufficient role |
404 | User not found |
POST /api/v1/users/{id}/restore
Restore a soft-deleted user (SYSTEM_ADMIN only).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | User UUID. |
Responses
| Status | Description |
|---|---|
200 | User restored |
403 | Insufficient role |
404 | User not found |