Skip to main content
GET
Retrieve review

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-13-1"

Path Parameters

id
string
required

The unique identifier of the review.

Example:

"rev_xxxxxxxxxxxxxx"

Response

Review details

account
object
required

The account that this review was written for.

attachments
object[]
required
created_at
string
required

When the review was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

description
string | null
required

The body text of the review containing the user's detailed feedback. Returns an empty string if no description was provided.

Example:

"Two years on and the paint still beads like the day it was coated."

id
string
required

The unique identifier for the review.

Example:

"rev_xxxxxxxxxxxxxx"

joined_at
string | null
required

When the reviewer first joined the product, as an ISO 8601 timestamp. Null if unknown.

Example:

"2026-01-01T12:00:00.000Z"

paid_for_product
boolean | null
required

Whether the reviewer paid for the product. Null if the payment status is unknown.

Example:

true

product
object
required

The product that this review was written for.

published_at
string | null
required

When the review was published, as an ISO 8601 timestamp. Null if unknown.

Example:

"2026-01-01T12:00:00.000Z"

stars
integer
required

The star rating given by the reviewer, from 1 to 5.

Example:

4

status
enum<string>
required

The moderation status of the review. Only published reviews are returned.

Available options:
published
Example:

"published"

title
string | null
required

A short summary title for the review. Null if the reviewer did not provide one.

Example:

"Worth every penny"

updated_at
string
required

When the review was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

user
object
required

The user account of the person who wrote this review.