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.

Response

Successful operation

id
string
required

The unique ID of the points system.

name
string
required

The name of the points system.

description
string | null
required

The description of the points system.

badgeUrl
string | null
required

The URL of the badge image for the points system, if one has been uploaded.

maxPoints
number | null
required

The maximum number of points a user can be awarded in this points system

triggers
PointsTrigger · object[]
required

Array of active triggers for this points system.