Relesys API Docs

v1.2

https://api.relesysapp.net/api/v1.2

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Highscores

List
GET /highscores 
https://api.relesysapp.net/api/v1.2/highscores
Get a list of highscores.
Default sort is by name in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.highscores, relesys.api.highscores:read
Query String
id string / guid Filterable optional
lastResetDate datetime Filterable Sortable optional
name string Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"5695f741-392f-4f55-8608-e9f2f8abc0d8","name":"Highscore example name 1","description":"Highscore example description 1","lastResetDate":"2024-04-27T23:46:42.0255866Z"},{"id":"75af1250-fec6-4268-b1ca-bba35a6fa175","name":"Highscore example name 2","description":"Highscore example description 2","lastResetDate":"2024-04-04T23:46:42.0255866Z"}]}
object
  count integer      
  ⯈ data array[object]      
   description string      
   id string / guid      
   lastResetDate datetime      
   name string      
  nextUrl string      
  previousUrl string