eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-04 13:06:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add an endpoint to view your own system

Browse source
This commit is contained in:
Ske 2019-07-15 20:06:28 +02:00
parent cc31664f8b
commit 39152dbd27
2 changed files with 28 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/3-api-documentation.md
View file

@ -50,6 +50,27 @@ The following three models (usually represented in JSON format) represent the va
## Endpoints
### `GET /s`
**Requires authentication.**
Returns information about your own system.
#### Example request
GET https://api.pluralkit.me/v1/s
#### Example response
```json
{
"id": "abcde",
"name": "My System",
"description": "This is my system description. Yay.",
"tag": "[MySys]",
"avatar_url": "https://path/to/avatar/image.png",
"tz": "Europe/Copenhagen",
"created": "2019-01-01T14:30:00.987654Z"
}
```
### `GET /s/<id>`
Queries a system by its 5-character ID, and returns information about it. If the system doesn't exist, returns `404 Not Found`.