Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

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
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