Relesys API Docs

Points

List

GET /highscores/{highscoreId}/points

https://api.relesysapp.net/api/v1.3/highscores/{highscoreId}/points

Get a list of all points given for the highscore with ID highscoreId.
Default sort is by creationDateTime in ascending order.

isManuallyGiven indicates whether a point entry has been manually given or not.
isActive indicates whether a point entry is given after the highscore's last time of point reset.

Scopes: relesys.api, relesys.api:read, relesys.api.highscores, relesys.api.highscores:read

URL Path

highscoreId

string / guid

required

Query String

creationDateTime	datetimeoffset	`Filterable` `Sortable`		optional
id	string / guid	`Filterable`		optional
isActive	boolean	`Filterable`		optional
isManuallyGiven	boolean	`Filterable`		optional
userId	string / guid	`Filterable`		optional
value	integer	`Filterable`		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

Schema Example

JSON

{"count":2,"data":[{"id":"cfda1bad-288e-4696-b87c-dab2cb9853b7","userId":"af1b8743-1d71-4d62-85c6-6cc853a6acf8","creationDateTime":"2024-07-24T06:40:21.3638789+00:00","description":"Example description 1","isManuallyGiven":true,"isActive":false,"value":10},{"id":"250ab475-0a76-4e3d-a103-cbd554936f62","userId":"67df542b-5c29-453b-9010-f1968966a4a0","creationDateTime":"2024-07-27T06:40:21.3638789+00:00","description":"Example description 2","isManuallyGiven":false,"isActive":true,"value":25}]}

object
count	integer
⯈ data	array[object]
creationDateTime	datetimeoffset
description	string
id	string / guid
isActive	boolean
isManuallyGiven	boolean
userId	string / guid
value	integer
nextUrl	string
previousUrl	string

Relesys API Docs

v1.3

Welcome

Concepts

Endpoints

Points

URL Path

Query String

Responses