Skip to main content
GET
Retrieve review
This page documents the Legacy API. For new integrations, use Retrieve review in the Current API.

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Parámetros de ruta

id
string
requerido

The unique identifier of the review to retrieve.

Ejemplo:

"rev_xxxxxxxxxxxxxx"

Respuesta

A successful response

A user-submitted review of a company, including a star rating and optional text feedback.

attachments
object[]
requerido

A list of files and media attached to the review.

company
object
requerido

The company that this review was written for.

created_at
string<date-time>
requerido

The datetime the review was created.

Ejemplo:

"2023-12-01T05:00:00.401Z"

description
string | null
requerido

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

Ejemplo:

"Great product, really helped me grow my audience."

id
string
requerido

The unique identifier for the review.

Ejemplo:

"rev_xxxxxxxxxxxxxx"

joined_at
string<date-time> | null
requerido

The timestamp of when the reviewer first joined the product. Null if unknown.

Ejemplo:

"2023-12-01T05:00:00.401Z"

paid_for_product
boolean | null
requerido

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

product
object
requerido

The product that this review was written for.

published_at
string<date-time> | null
requerido

The timestamp of when the review was published. Null if the review has not been published yet.

Ejemplo:

"2023-12-01T05:00:00.401Z"

stars
integer
requerido

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

Ejemplo:

42

status
enum<string>
requerido

The current moderation status of the review.

Opciones disponibles:
pending,
published,
removed
title
string | null
requerido

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

Ejemplo:

"Amazing community and tools"

updated_at
string<date-time>
requerido

The datetime the review was last updated.

Ejemplo:

"2023-12-01T05:00:00.401Z"

user
object
requerido

The user account of the person who wrote this review.