List claimed products

curl --request GET \
  --url https://www.closient.com/products/api/v1/products/ \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.closient.com/products/api/v1/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://www.closient.com/products/api/v1/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 => [
    "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;
}

package main

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

func main() {

	url := "https://www.closient.com/products/api/v1/products/"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://www.closient.com/products/api/v1/products/")

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

{
  "data": [
    {
      "id": "<string>",
      "gtin": "<string>",
      "product_name": "<string>",
      "is_claimed": true,
      "confidence_score": 0.5,
      "field_confidence": {},
      "date_label_compliance": {
        "ca_ab660": "<string>",
        "federal": "<string>",
        "notes": [
          "<string>"
        ]
      },
      "metadata": {},
      "brand": "",
      "manufacturer": "",
      "description": "",
      "image_url": "",
      "country_of_origin": "",
      "net_content": "",
      "net_content_value": 123,
      "owner_id": "<string>",
      "length": 123,
      "length_uom": "",
      "width": 123,
      "width_uom": "",
      "height": 123,
      "height_uom": "",
      "depth": 123,
      "depth_uom": "",
      "gross_weight": 123,
      "gross_weight_uom": "",
      "net_weight": 123,
      "net_weight_uom": "",
      "gpc_brick_code": "",
      "gpc_class_code": "",
      "gpc_family_code": "",
      "gpc_segment_code": "",
      "sensitivities": [
        {
          "slug": "<string>",
          "name": "<string>",
          "verified": true,
          "reasoning": "",
          "citations": [
            {}
          ]
        }
      ]
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

GET

products

api

products

List claimed products

curl --request GET \
  --url https://www.closient.com/products/api/v1/products/ \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.closient.com/products/api/v1/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://www.closient.com/products/api/v1/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 => [
    "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;
}

package main

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

func main() {

	url := "https://www.closient.com/products/api/v1/products/"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://www.closient.com/products/api/v1/products/")

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

{
  "data": [
    {
      "id": "<string>",
      "gtin": "<string>",
      "product_name": "<string>",
      "is_claimed": true,
      "confidence_score": 0.5,
      "field_confidence": {},
      "date_label_compliance": {
        "ca_ab660": "<string>",
        "federal": "<string>",
        "notes": [
          "<string>"
        ]
      },
      "metadata": {},
      "brand": "",
      "manufacturer": "",
      "description": "",
      "image_url": "",
      "country_of_origin": "",
      "net_content": "",
      "net_content_value": 123,
      "owner_id": "<string>",
      "length": 123,
      "length_uom": "",
      "width": 123,
      "width_uom": "",
      "height": 123,
      "height_uom": "",
      "depth": 123,
      "depth_uom": "",
      "gross_weight": 123,
      "gross_weight_uom": "",
      "net_weight": 123,
      "net_weight_uom": "",
      "gpc_brick_code": "",
      "gpc_class_code": "",
      "gpc_family_code": "",
      "gpc_segment_code": "",
      "sensitivities": [
        {
          "slug": "<string>",
          "name": "<string>",
          "verified": true,
          "reasoning": "",
          "citations": [
            {}
          ]
        }
      ]
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

organization_id

string

required

UUID of the Organization whose claimed products should be listed. Caller must have visibility into the organization.

include_low

boolean

default:false

Include LOW-severity dietary-sensitivity flags in each product's sensitivities list. Defaults to false; HIGH and MODERATE flags are always included.

avoid_sensitivity

string

default:""

Comma-separated sensitivity slugs to filter out (e.g. histamine,sulfites). Products flagged with ANY of these at or above min_severity are excluded from the results. Empty (default) applies no sensitivity filter.

min_severity

string

default:MODERATE

Severity threshold for avoid_sensitivity filtering: a product is excluded only when it carries a listed sensitivity at this band or higher. One of HIGH, MODERATE, LOW; defaults to MODERATE (LOW flags do not exclude by default). Ignored when avoid_sensitivity is empty. An unrecognized value returns 422.

page

integer

default:1

Page number (1-indexed).

Required range: x >= 1

page_size

integer

default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

data

ProductOut · object[]

required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

Show child attributes

pagination

PaginationMeta · object

required

Pagination envelope describing position within the full result set.

Show child attributes

Example:

{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}

Overview

Account

Products

Brands

Locations

Retailers

Search

GS1 Digital Link

EPCIS 2.0

Integrations

Billing

Scanner

Compliance

Certifications

Sustainability

Notifications

Dashboard

Analytics

Agent

Substances

BYOS

Content

Signals

List claimed products

Authorizations

Query Parameters

Response