Skip to main content
GET
/
products
/
api
/
v1
/
browse
/
products
List products
curl --request GET \
  --url https://www.closient.com/products/api/v1/browse/products \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "gtin": "<string>",
      "is_claimed": true,
      "created": "2023-11-07T05:31:56Z",
      "product_name": "",
      "brand": "",
      "description": "",
      "owner_id": "<string>"
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
brand_short_id
string | null

Limit results to products belonging to the brand with this URL-safe short identifier.

​
active
boolean | null

When true, return only currently-active products (resolver-enabled and not retired). When false, return only inactive products. Omit to return both.

​
ordering
string | null

Sort field; prefix with - for descending order. Allowed: product_name, created.

​
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

200 - application/json

OK

​
data
ProductBrowseOut · 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.

​
pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

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