Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

shop_id
string[]

Only these connected shops, comma-separated; default every connected shop of the workspace. A shop outside the workspace is 404.

listing_id
string

Only this listing's reviews. A listing outside the workspace is 404.

Pattern: ^[0-9]{1,20}$
rating
string

At least this many stars, 1 to 5 (5: only 5-star reviews).

Pattern: ^[1-5]$
rating_max
string

At most this many stars, 1 to 5 (2: only 1- and 2-star reviews).

Pattern: ^[1-5]$
Example:

"2"

from
string

Written at or after this time (a date is midnight UTC).

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d{1,3})?)?(Z|[+-]\d{2}:\d{2}))?$
Example:

"2026-07-19"

to
string

Written before this time.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d{1,3})?)?(Z|[+-]\d{2}:\d{2}))?$
has_text
enum<string>

true: only reviews with text; false: only reviews without.

Available options:
true,
false
Example:

"true"

has_photo
enum<string>

true: only reviews with the buyer's photo; false: only reviews without one.

Available options:
true,
false
sort
enum<string>

-created (newest first, the default), created, -rating (most stars first) or rating; within one rating newest first.

Available options:
-created,
created,
-rating,
rating
limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required
summary
object
required

Over every review that matches the filters, not just this page; the same on every page.