List points levels

List points levels for a system.

GET /points/{systemId}/levels

JavaScript

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const levels = await trophy.admin.points.levels.list('system-uuid', {
  limit: 10,
  skip: 0
});

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

levels = client.admin.points.levels.list(
  system_id='system-uuid',
  limit=10,
  skip=0
)

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Admin.Points.Levels.List(context.TODO(), "system-uuid", nil)

curl --request GET \
  --url https://admin.trophy.so/v1/points/{systemId}/levels \
  --header 'X-API-KEY: <api-key>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points/{systemId}/levels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://admin.trophy.so/v1/points/{systemId}/levels")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/points/{systemId}/levels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Bronze",
    "key": "bronze",
    "points": 100,
    "description": "Starting level",
    "badge": null
  },
  {
    "id": "660f9500-f30c-42e5-b827-557766550001",
    "name": "Silver",
    "key": "silver",
    "points": 500,
    "description": "Intermediate level",
    "badge": {
      "url": "https://example.com/silver.png"
    }
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

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.

Query Parameters

limit · integer · default: 10

Number of records to return.

Required range: 1 <= x <= 100

skip · integer · default: 0

Number of records to skip from the start of the list.

Required range: x >= 0

Response

200

application/json

A paginated list of points levels.

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.

Show child attributes