Skip to main content
GET
/
points
/
{key}
/
boosts
JavaScript
import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await trophy.points.boosts("points-system-key");
[
  {
    "id": "0040fe51-6bce-4b44-b0ad-bddc4e123537",
    "name": "Double XP Weekend",
    "status": "active",
    "start": "2025-01-01",
    "end": "2025-01-03",
    "multiplier": 2,
    "rounding": "down"
  },
  {
    "id": "0040fe51-6bce-4b44-b0ad-bddc4e123538",
    "name": "Holiday Bonus",
    "status": "finished",
    "start": "2024-12-25",
    "end": "2024-12-31",
    "multiplier": 1.5,
    "rounding": "nearest"
  }
]
Rate Limits

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
key
string
required

Key of the points system.

Query Parameters

​
includeFinished
boolean
default:false

When set to 'true', boosts that have finished (past their end date) will be included in the response. By default, finished boosts are excluded.

Response

Successful operation

​
id
string
required

The ID of the points boost

​
name
string
required

The name of the points boost

​
status
enum<string>
required

The status of the points boost

Available options:
active,
scheduled,
finished
​
start
string
required

The start date of the points boost

​
end
string | null
required

The end date of the points boost

​
multiplier
number
required

The multiplier of the points boost

​
rounding
enum<string>
required

The rounding method of the points boost

Available options:
down,
up,
nearest