Retrieve a feature - Kelviq Documentation

Retrieve a feature

curl --request GET \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/', 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://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
  "identifier": "api-calls",
  "name": "API Calls",
  "description": "Number of API calls per billing cycle.",
  "featureType": "METER",
  "featureDetails": {
    "featureSubType": "PRE_AGGREGATED_USAGE",
    "units": {
      "singular": "call",
      "plural": "calls"
    }
  },
  "meter": {},
  "details": {},
  "metadata": {
    "category": "core"
  },
  "isArchived": false,
  "modifiedOn": "2025-04-12T08:21:14.910Z"
}

GET

/

catalog

/

features

/

{pk}

/

Retrieve a feature

curl --request GET \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/', 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://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/features/{pk}/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
  "identifier": "api-calls",
  "name": "API Calls",
  "description": "Number of API calls per billing cycle.",
  "featureType": "METER",
  "featureDetails": {
    "featureSubType": "PRE_AGGREGATED_USAGE",
    "units": {
      "singular": "call",
      "plural": "calls"
    }
  },
  "meter": {},
  "details": {},
  "metadata": {
    "category": "core"
  },
  "isArchived": false,
  "modifiedOn": "2025-04-12T08:21:14.910Z"
}

Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization

string

header

required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

pk

string<uuid>

required

Feature UUID.

Response

Feature details.

A feature that can be granted as an entitlement on a plan.

id

string<uuid>

read-only

Example:

"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01"

identifier

string

URL-safe slug, auto-generated from name if not provided.

Example:

"api-calls"

name

string

Example:

"API Calls"

description

string

Example:

"Number of API calls per billing cycle."

featureType

enum<string>

BOOLEAN: on/off flag. CUSTOMIZABLE: numeric limit. METER: usage-based metering.

Available options:

BOOLEAN,

CUSTOMIZABLE,

METER

Example:

"METER"

featureDetails

object

Configuration for the feature. For METER features, expects featureSubType (PRE_AGGREGATED_USAGE or RAW_EVENTS), units, and optionally customerUnit for unit conversion.

Example:

{
  "featureSubType": "PRE_AGGREGATED_USAGE",
  "units": { "singular": "call", "plural": "calls" }
}

meter

object

For RAW_EVENTS meter features: an object with aggregation (function, field) and filters.

Example:

{}

details

object

read-only

Example:

{}

metadata

object

Example:

{ "category": "core" }

isArchived

boolean

read-only

Example:

false

modifiedOn

string<date-time>

read-only

Example:

"2025-04-12T08:21:14.910Z"