Relesys API Docs

Points

List

GET /highscores/{highscoreId}/points

https://api.relesysapp.net/api/v1.2/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":"28737693-de67-48d7-b30e-f8bffd18367b","userId":"24a57aea-48eb-4e87-b2ca-47a29df0ed51","creationDateTime":"2024-04-24T15:17:06.637455+00:00","description":"Example description 1","isManuallyGiven":true,"isActive":false,"value":10},{"id":"13d74f33-5148-4a5a-a07f-3950bc1c5c5c","userId":"f1fc9e7d-e4b9-4bd4-acb3-c181b15ed580","creationDateTime":"2024-04-27T15:17:06.637455+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.2

Welcome

Concepts

Endpoints

Points

URL Path

Query String

Responses