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

id
string<uuid>
required

The ID of the points system.

Response

Successful operation

A points system returned from the admin points systems endpoints.

id
string<uuid>
required

The UUID of the points system.

name
string
required

The points system name.

key
string
required

The points system key.

description
string
required

The points system description.

status
enum<string>
required

The points system status.

Available options:
active,
archived
badge
object | null
required

The badge for the points system.

maxPoints
integer | null
required

The maximum points a user can earn.