shockrah/freechat
shockrah/freechat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

➕ New docs describing new /members/single route

Browse Source
This commit is contained in:
shockrah 2021-03-05 19:26:11 -08:00
parent 898a7a8ca2
commit cf1dee9842
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/content/endpoints/members.md
View File

@ -32,6 +32,7 @@ weight: 14
* Member * Member
* Contains all public data about your account on the server * Contains all public data about your account on the server
Example Example
``` ```
> GET /members/me?id=123&jwt=... > GET /members/me?id=123&jwt=...
@ -44,6 +45,34 @@ Example
< } < }
``` ```
### `GET /members/single`
* Required query string parameters:
* id: u64
* jwt: String
* member_id: u64
* Returns
* Full Public User
* Behind the key 'member`
Example
```
> GET /members/single
< {
< "name": "nickname-here",
< "id": 0, // always 0
< "joindate": <unix-timestamp>,
< "status": 1|2
< "permissions": <64-bit-mask>
< }
```
### `GET /members/online` ### `GET /members/online`
* Required query string parameters: * Required query string parameters: