Get a points boost by ID
Get a single points boost by ID.
Authorizations
Headers
The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.
Path Parameters
The UUID of the points system.
The UUID of the points boost.
Response
The points boost.
A points boost as returned from admin endpoints.
The UUID of the boost.
The name of the boost.
The status of the boost.
active, scheduled, finished The start date (YYYY-MM-DD).
The end date (YYYY-MM-DD) or null if no end date.
The points multiplier.
How boosted points are rounded.
down, up, nearest The ID of the user the boost was created for, or null for global/attribute-filtered boosts.
User attribute filters applied to the boost. Only present for non-user-specific boosts (i.e. when userId is null). Empty array if no filters are set.