Skip to main content
GET
List Reviews

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

organizationId
string

Required for session auth. API keys already belong to one organization.

Maximum string length: 160
q
string

Search the comment, product name or SKU, marketplace item id, and review id.

Maximum string length: 200
marketplace
enum<string>
Available options:
shopee,
lazada,
tiktok,
shopify,
zalora,
amazon,
ebay
status
enum<string>
Available options:
open,
replied,
hidden,
handoff,
solicited,
ineligible
priority
enum<string>

unreplied: open reviews the marketplace allows a reply to. negative: rating of 3 or lower.

Available options:
unreplied,
negative
store
string

Comma-separated store (account) ids from GET /api/v1/marketplaces/connected.

Maximum string length: 1000
productId
string<uuid>

A product or variant UUID. Includes reviews of the whole product family.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
sortBy
string

Comma-separated sort keys: reviewed_desc, reviewed_asc, rating_desc, rating_asc, status_asc, status_desc, marketplace_asc, marketplace_desc, product_asc, product_desc. Defaults to reviewed_desc.

Maximum string length: 200
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991

Response

A page of reviews.

ok
boolean
required
apiVersion
string
required
Allowed value: "developer_v1"
operationId
string
required
status
enum<string>
required
Available options:
accepted,
completed,
failed
warnings
string[]
required
recommendations
string[]
required
data
object
required
jobId
string
productId
string