Saltar al contenido principal
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"
  }
]
Límites de velocidad

Autorizaciones

X-API-KEY
string
header
requerido

Parámetros de ruta

key
string
requerido

Key of the points system.

Parámetros de consulta

includeFinished
boolean
predeterminado: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.

Respuesta

Successful operation

id
string
requerido

The ID of the points boost

name
string
requerido

The name of the points boost

status
enum<string>
requerido

The status of the points boost

Opciones disponibles:
active,
scheduled,
finished
start
string
requerido

The start date of the points boost

end
string | null
requerido

The end date of the points boost

multiplier
number
requerido

The multiplier of the points boost

rounding
enum<string>
requerido

The rounding method of the points boost

Opciones disponibles:
down,
up,
nearest