api/docs/user/info.md

28 lines
1.2 KiB
Markdown
Raw Normal View History

# `/user/info` - GET
Returns information about the project.
## Urlencoded Parameters
You have to set one parameter.
Setting none or two parameters will result in a _400 Bad Request_ Response.
| Parameter | Description |
|-----------|--------------------------------------------------------------------|
| name | The username of the user on which the operation will be performed. |
| id | The userid of the user on which the operation will be performed. |
## Responses
### 200 - Success
__Content - JSON:__
| Field | Description |
|----------|-------------------------------------------------------------------|
| id | The users unique id. |
| name | The users unique username. |
| joined | The datetime when the user joined. Represented as UNIX timestamp. |
| is_admin | A boolean if the user is an admin. |
### 400 - Error: Bad Request
The request was malformed.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
The user wasn't found.