Relesys API Docs

v1.1

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings

Endpoints

Highscore Levels

Get Levels
GET /highscores/{highscoreId}/levels 
https://api.relesysapp.net/api/v1.1/highscores/{highscoreId}/levels
Get a list levels attached the highscore with ID highscoreId.
Default sort is by name in ascending order.

Please note: This endpoint is only available if highscore levels have been enabled for the highscore.
Scopes: relesys.api, relesys.api:read, relesys.api.highscores, relesys.api.highscores:read
URL Path
highscoreId string / guid required
Query String
alias string Filterable Sortable optional
id string / guid Filterable optional
name string Filterable Sortable optional
requiredPoints integer 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":"30ee1494-b750-4322-8dea-aed47ce4fd42","name":"Highscore level name example 1","externalId":"External Id example 1","requiredPoints":100},{"id":"b89f6387-1b66-41c4-b1d5-ce3f728c940a","name":"Highscore level name example 2","externalId":"External Id example 2","requiredPoints":250}]}
object
  count integer      
  ⯈ data array[object]      
   alias string      
   id string / guid      
   name string      
   requiredPoints integer      
  nextUrl string      
  previousUrl string