Skip to main content
GET
/
v3
/
achievements
/
definitions
Browse Achievement Definitions
curl --request GET \
  --url https://api.{tenant}.getomneo.com/api/v3/achievements/definitions
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.{tenant}.getomneo.com/api/v3/achievements/definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "region_id": 123,
      "region": {
        "id": 123,
        "name": "<string>",
        "handle": "<string>"
      },
      "currency": "<string>",
      "description": "<string>",
      "internal_notes": "<string>",
      "type": "<string>",
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "is_published": true,
      "display_level": true,
      "display_option": "<string>",
      "short_description": "<string>",
      "long_description": "<string>",
      "terms_conditions": "<string>",
      "earn_instructions": "<string>",
      "icon": "<string>",
      "image_url": "<string>",
      "levels": [
        {
          "id": 123,
          "name": "<string>",
          "achievement_definition_id": 123,
          "display_number": 123,
          "description": "<string>",
          "trigger": 123,
          "repeats": true,
          "repeat_interval": 123,
          "allow_multiple_earn": true,
          "computed_display_number": "<string>",
          "computed_trigger": "<string>",
          "meta": [
            "<unknown>"
          ]
        }
      ],
      "tags": [
        "<string>"
      ],
      "meta": [
        "<unknown>"
      ],
      "timezone": "<string>",
      "period": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "enable_annual_earn_cycle": true
    }
  ]
}
{
"message": "<string>"
}
{
"message": "<string>"
}

Query Parameters

page[size]
string

Response

Array of AchievementDefinition

data
AchievementDefinition · object[]
required