Users

List of endpoints for our "Users" category.

get
Get User

https://api.chatwindapp.com/users/:uid
This endpoint allows you to get a user's information from the Chatwind database. Ratelimit: 5req/1s
Request
Response
Request
Path Parameters
uid
required
string
The username of the user that you would like to search.
Response
200: OK
User information successfully retrieved.
{
"username": "milanm",
"created_at": "2021-04-01T04:06:06.763Z",
"premium": 2,
"staff": true,
"verified": true,
"blacklisted": false
}
404: Not Found
User information returned an error.
{
"error":true,
"message":"User not found",
"code":404
}

put
Modify user

https://api.chatwindapp.com/users/edit
This endpoint allows you to edit a user's information. Ratelimit: 5req/420s
Request
Response
Request
Query Parameters
oldpassword
required
string
The OLD password of the user
oldusername
required
string
The OLD username of the user
password
required
string
NEW password for the user (can be the old one)
email
required
string
NEW email for the user (can be the old one)
username
required
string
The NEW username for the user (can be the old one)
Response
200: OK
User successfully modified.
{
"username": "milanm",
"created_at": "2021-04-01T04:06:06.763Z",
"premium": 2,
"staff": true,
"verified": true,
"blacklisted": false
}
403: Forbidden
Invalid oldpassword provided.
{
"error": true,
"message": "Old password is invalid",
"code": 403
}
404: Not Found
User not found
{
"error": true,
"message": "User not found",
"code": 404
}

patch
Verify Email

https://api.chatwindapp.com/users/verify
Verify a user's email address through this endpoint. Ratelimit: 100req/0.5s
Request
Response
Request
Query Parameters
token
required
string
The verify token, sent to the user on register/edit -- 200 char.
Response
200: OK
Successfully verified the user's email
{
"username": "milanm",
"created_at": "2021-04-01T04:06:06.763Z",
"premium": 2,
"staff": true,
"verified": true,
"blacklisted": false
}
404: Not Found
Token not found
{
"error":true,
"message":"Token not found",
"code":400
}