Skip to main content
GET
/
v1
/
products
Get Products
curl --request GET \
  --url https://api.trykintsugi.com/v1/products/ \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'
{
  "items": [
    {
      "external_id": "prod_001",
      "code": "CODE_1001",
      "name": "Sample Product A",
      "description": "This is a sample product description.",
      "status": "PENDING",
      "product_category": "PHYSICAL",
      "product_subcategory": "GENERAL_CLOTHING",
      "tax_exempt": false,
      "source": "BIGCOMMERCE",
      "connection_id": "conn_12345",
      "classification_failed": true,
      "id": "prod_abc123"
    },
    {
      "external_id": "prod_002",
      "code": "CODE_1002",
      "name": "Sample Product B",
      "status": "APPROVED",
      "product_category": "SERVICE",
      "product_subcategory": "PROFESSIONAL_SERVICE",
      "tax_exempt": false,
      "source": "STRIPE",
      "classification_failed": false,
      "id": "prod_def456"
    }
  ],
  "total": 2,
  "page": 1,
  "size": 50,
  "pages": 1
}

Authorizations

X-API-KEY
string
header
required
x-organization-id
string
header
required

Query Parameters

query
string

Search term to filter products by name or other details.

status__in
string

Filter products by status (comma-separated)

product_category__in
string

Filter products by category (comma-separated)

product_subcategory__in
string

Filter products by subcategory (comma-separated)

source__in
string

Filter products by source (comma-separated)

order_by
string

Order results by specified fields (comma-separated)

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successfully retrieved products

items
ProductRead · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1
pages
integer
required
Required range: x >= 0