List products

List products

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

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

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/products/', 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/products/",
  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/products/"

	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/products/")

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
      "identifier": "pro-suite",
      "name": "Pro Suite",
      "description": "Premium tools for growing teams.",
      "taxCode": "saas",
      "createdBy": "Jane Smith",
      "modifiedOn": "2025-04-12T08:21:14.910Z",
      "images": [
        {
          "id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
          "name": "hero-banner.png",
          "image": "media/.../products/<id>/<uuid>/hero-banner.png",
          "ordering": 0,
          "thumbnail": true,
          "enabled": true
        }
      ]
    }
  ]
}

GET

catalog

products

List products

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

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

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/products/', 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/products/",
  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/products/"

	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/products/")

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
      "identifier": "pro-suite",
      "name": "Pro Suite",
      "description": "Premium tools for growing teams.",
      "taxCode": "saas",
      "createdBy": "Jane Smith",
      "modifiedOn": "2025-04-12T08:21:14.910Z",
      "images": [
        {
          "id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
          "name": "hero-banner.png",
          "image": "media/.../products/<id>/<uuid>/hero-banner.png",
          "ordering": 0,
          "thumbnail": true,
          "enabled": true
        }
      ]
    }
  ]
}

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'

Query Parameters

string

Free-text search across name, identifier, and description.

page

integer

Page number for pagination.

page_size

integer

Number of results per page. Defaults to 100, maximum 100.

Required range: 1 <= x <= 100

Response

Paginated list of products.

count

integer

Example:

1

string | null

Example:

null

string | null

Example:

null

results

object[]

Show child attributes

Get Started

API Documentation

Authorizations

Query Parameters

Response