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. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

systemId
string<uuid>
required

The UUID of the points system.

id
string<uuid>
required

The UUID of the points level.

Response

The points level.

A points level as returned from admin endpoints.

id
string<uuid>
required

The UUID of the level.

name
string
required

The name of the level.

key
string
required

The level key.

points
integer
required

The threshold points value for the level.

description
string
required

The level description.

badge
object | null
required

The badge for the level, or null if no badge is set.