KintsugiKintsugi

List products

GET/products

List products, keyset-paginated. Covers every organization your credential owns; send an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Filter with status, source (comma-separated), search, productCategory and productSubcategory, and sort with orderBy/order; omit orderBy to page in the default id order. Pass limit and the opaque cursor from a prior response to page. A cursor is only valid for the sort, filters AND organization scope it was issued under, including any selector header: change any of them and start again from the first page.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Narrow the request to one organization (Organization-Id selector).

Connection-Idstring

Narrow the request to a connection's organization.

Entity-Idstring

Narrow the request to a platform entity's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Query

Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.

/products?orderBy=<orderBy>&order=<order>&status=<status>
orderByPublicProductSortEnum

Field to sort by. Omit to page in the default id order (fastest); the other keys sort the whole matching set.

Available options:namestatuscreatedAtexternalIdsource
orderPublicProductSortOrder

Sort direction. Applies only when orderBy is set.

Available options:ascdesc
statusstring

Comma-separated approval statuses; matches any of them.

sourcestring

Comma-separated source systems; matches any of them.

searchstring

Search over product id, externalId, name and description. id and externalId must match exactly; name and description match a case-insensitive substring.

productCategoryPublicProductCategoryEnum

Tax category to filter by. Matches every product in the category regardless of subcategory; combine with productSubcategory to narrow.

Available options:DigitalMiscPhysicalServices
productSubcategorystring

Tax subcategory display label to filter by (e.g. 'General Clothing'). An unrecognized label matches no products.

limitinteger

Maximum number of items to return.

cursorstring

Opaque cursor from a prior response's nextCursor or previousCursor. Omit for the first page.

Response

itemsProduct[]Required

The results on this page. Empty when there are none.

nextCursorstring

Opaque cursor for the next page. null when this is the last page. Send it back as cursor; do not parse it.

previousCursorstring

Opaque cursor for the previous page. null when this is the first page. Send it back as cursor; do not parse it.

hasMoreboolean

Whether a page exists after this one.

hasPreviousboolean

Whether a page exists before this one.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL
GET /products?orderBy={orderBy}&order=asc&status={status}
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/products?orderBy={orderBy}&order=asc&status={status}
Response
{
"items": [
{
"id": "prod_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"organizationName": "Acme Corp",
"externalId": "order-1001",
"sku": [
"sku-1001"
],
"code": "Physical",
"name": "Acme Corp",
"description": "Annual software subscription",
"status": "APPROVED",
"productCategory": "Physical",
"productSubcategory": "General Clothing",
"taxExempt": false,
"sourceTaxExempt": false,
"source": "API",
"connectionId": "conn_2mNpQr7Ls8f3k",
"storeName": "Acme Corp",
"classificationFailed": false
}
],
"nextCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"previousCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"hasMore": false,
"hasPrevious": false
}
List products (2026-07-21) | Kintsugi API Reference