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":"6bbba983-451c-4a97-a9ca-4c7370340055","userId":"f515fa84-8e2c-4aa7-9be2-f98aa528222c","creationDateTime":"2024-10-01T05:14:14.5174858+00:00","description":"Example description 1","isManuallyGiven":true,"isActive":false,"value":10},{"id":"6c9d482a-d713-4dad-9520-1a75167db22c","userId":"ce584be4-5ddb-4c68-b05c-2242e7993c9c","creationDateTime":"2024-10-04T05:14:14.5174858+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