Get boosts for a points system
Get all global boosts for a points system. Finished boosts are excluded by default.
Authorizations
Headers
The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.
Path Parameters
Key of the points system.
Query Parameters
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
The ID of the points boost
The name of the points boost
The status of the points boost
active, scheduled, finished The start date of the points boost
The end date of the points boost
The multiplier of the points boost
The rounding method of the points boost
down, up, nearest