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

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

response = requests.get(url)

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

fetch('https://api.{tenant}.getomneo.com/api/v3/credits/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/credits/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/credits/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/credits/definitions")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/credits/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>"
      },
      "timezone": "<string>",
      "period": 123,
      "period_type": "<string>",
      "absolute_expiry": "<string>",
      "release_period": 123,
      "release_period_type": "<string>",
      "release_period_absolute_expiry": "<string>",
      "is_published": true,
      "is_archived": true,
      "icon": "<string>",
      "image_url": "<string>",
      "primary_colour": "<string>",
      "secondary_colour": "<string>",
      "description": "<string>",
      "internal_notes": "<string>",
      "short_description": "<string>",
      "long_description": "<string>",
      "terms_conditions": "<string>",
      "earn_instructions": "<string>",
      "meta": [
        "<unknown>"
      ],
      "type": "<string>",
      "value": 123,
      "max_value": 123,
      "currency_id": 123,
      "currency": "<string>",
      "require_creator": true,
      "require_assigned": true,
      "is_extendable": true,
      "is_assignable": true,
      "is_releasable": true,
      "is_reassignable": true,
      "require_security_code": true,
      "extend_days": 123,
      "credit_number_range_type": "<string>",
      "credit_number_range_start": "<string>",
      "credit_number_range_end": "<string>",
      "credit_number_length": 123,
      "security_code_type": "<string>",
      "use_custom_numbers": true,
      "notify_schedule_offset": 123,
      "issue_target_id": 123,
      "expiry_target_id": 123,
      "release_target_id": 123,
      "remind_target_id": 123,
      "extend_target_id": 123,
      "notify_issue_offset_days": 123,
      "notify_issue_offset_hour": 123,
      "notify_remind_offset_days": 123,
      "notify_remind_offset_hour": 123,
      "tags": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "custom_fields": [
        {
          "name": "<string>",
          "handle": "<string>",
          "namespace": "<string>",
          "value": "<string>",
          "type": "<string>",
          "custom_fieldable_type": "<string>",
          "custom_fieldable_id": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "is_index": "<string>"
        }
      ]
    }
  ]
}
{
"message": "<string>"
}
{
"message": "<string>"
}

Query Parameters

page[size]
string

Response

Array of CreditDefinition

data
CreditDefinition · object[]
required