Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.hitopen.com/llms.txt

Use this file to discover all available pages before exploring further.

Use these endpoints to retrieve and update your own account profile, or — if you have admin access — to query and manage other users on the instance.
Self-service endpoints (/api/user/self) require User permission. Admin endpoints (GET /api/user/ and GET /api/user/{id}) require Admin permission. Authenticate with a system access token from Personal Settings → Security Settings → System Access Tokens.

​
Endpoints

MethodPathPermissionDescription
GET/api/user/selfUserGet your own profile
PUT/api/user/selfUserUpdate your own profile
DELETE/api/user/selfUserDelete your own account
GET/api/user/{id}AdminGet a user by ID
GET/api/user/AdminList all users

​
Get your own profile

GET /api/user/self
Returns the profile of the currently authenticated user, including quota, group membership, and account status.

​
Example

curl -X GET "https://YOUR_NEWAPI_BASE_URL/api/user/self" \
  -H "Authorization: Bearer your-access-token"

​
Response fields

​
success
boolean
Whether the request succeeded.
​
data
object
The user object.

​
Update your own profile

PUT /api/user/self
Updates fields on the currently authenticated user’s profile. Only include the fields you want to change.

​
Request body

​
username
string
New login username. Must be unique across the instance.
​
display_name
string
New display name shown in the console.
​
password
string
New password. Requires original_password to be provided.
​
original_password
string
Your current password. Required when changing password.

​
Example

curl -X PUT "https://YOUR_NEWAPI_BASE_URL/api/user/self" \
  -H "Authorization: Bearer your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Jane Smith",
    "password": "new-secure-password",
    "original_password": "current-password"
  }'

​
Delete your own account

DELETE /api/user/self
Permanently deletes the currently authenticated user’s account and all associated tokens. This action cannot be undone.
Deleting your account removes all your API tokens immediately. Any application using those tokens will lose access. There is no recovery option.

​
Example

curl -X DELETE "https://YOUR_NEWAPI_BASE_URL/api/user/self" \
  -H "Authorization: Bearer your-access-token"

​
Get a user by ID

GET /api/user/{id}
Requires Admin permission.
Returns the profile of any user on the instance by their numeric ID.

​
Path parameters

​
id
integer
required
The numeric ID of the user to retrieve.

​
Example

curl -X GET "https://YOUR_NEWAPI_BASE_URL/api/user/15" \
  -H "Authorization: Bearer your-access-token"

​
List all users

GET /api/user/
Requires Admin permission.
Returns a paginated list of all users on the instance.

​
Query parameters

​
p
integer
Page number (1-indexed). Defaults to 1.
​
page_size
integer
Number of users to return per page. Defaults to 10.

​
Example

curl -X GET "https://YOUR_NEWAPI_BASE_URL/api/user/?p=1&page_size=50" \
  -H "Authorization: Bearer your-access-token"