BizKitHub
DocsAPI ReferenceReview/api/v1/shop/review/list
getReviewPublic API v1

/api/v1/shop/review/list

Visible reviews newest first plus a summary (average, count, star distribution) over all visible reviews in scope. Reviews hidden in the admin are never returned.

reviewgetApiV1ShopReviewList

Parameters

5 query

Query parameters

· 5
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
productSlugstringOptional

Slug of the product. Omit for a review of the shop itself.

Exampleset-start
scope"shop" | "products"Optional

Without productSlug: shop (default) = reviews of the shop, products = all product reviews.

pagestringOptional
Example1
limitstringOptional

1–100, default 20.

Example20

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Public review id.

authorstringRequired

Author name as entered by the customer.

initialsstringRequired

One or two initials for an avatar.

ratingnumberRequired

Stars, 1–5.

textstringOptional
datestringRequired

ISO date of the review.

replystringOptional

Public reply of the shop.

replyDatestringOptional
localestringOptional

Language the review was written in, when known.

productSlugstringOptional

Reviewed product (only with scope=products).

isVerifiedPurchasebooleanRequired

The review is tied to a real order of the author.

summaryobjectRequired
averagenumber | nullRequired
One of 2:
Variant 1
number

Average rating rounded to one decimal; null without reviews.

Variant 2
null
countnumberRequired

Number of visible reviews.

distributionnumber[]Required

Count per star: index 0 = 1 star … index 4 = 5 stars.

pagenumberRequired
limitnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "author": "example_author",
      "initials": "example_initials",
      "rating": 0,
      "text": "example_text",
      "date": "example_date",
      "reply": "example_reply",
      "replyDate": "example_replyDate",
      "locale": "example_locale",
      "productSlug": "example_productSlug",
      "isVerifiedPurchase": false
    }
  ],
  "summary": {
    "count": 0,
    "distribution": [
      0
    ]
  },
  "page": 0,
  "limit": 0
}

Request example

GET /api/v1/shop/review/list

get
curl -X GET "https://api.bizkithub.com/api/v1/shop/review/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&productSlug=set-start&page=1&limit=20" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key