Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Etsy listing ID.

Pattern: ^[1-9][0-9]{0,19}$
Example:

"4524717183"

Query Parameters

rating
string

Only reviews with this many stars, 1 to 5.

Pattern: ^[1-5]$
q
string

Words to find in the review text; every word must appear (any letter case).

has_image
enum<string>

true: only reviews with a photo; false: only reviews without one.

Available options:
true,
false
language
string

Only reviews written in this language, as a code (en, de).

Pattern: ^[A-Za-z]{2,3}$
from
string

Only reviews written at or after this time.

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

Only reviews written at or 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}))?$
limit
integer

Page size: at most 25, the default.

Required range: 1 <= x <= 25
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.