List points systems

List points systems.

GET /points

JavaScript

JavaScript

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

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

const systems = await trophy.admin.points.systems.list({
  limit: 10,
  skip: 0
});

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

systems = client.admin.points.systems.list(
  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.Systems.List(context.TODO(), nil)

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points",
  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")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/points")

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": "XP",
    "key": "xp",
    "description": "Experience points",
    "status": "active",
    "badge": null,
    "maxPoints": null
  }
]

{
  "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.

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

Successful operation

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.

Show child attributes

maxPoints · integer | null · required

The maximum points a user can earn.