Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-Api-Key-Here

Path Parameters

ID of the payment link / product whose reviews you want to retrieve.

Query Parameters

number
Maximum number of reviews to return per page. Used for cursor pagination.
string
Cursor for the next page. Pass the nextStartingAfter value from the previous response.
number
Filter reviews by rating value (1–5).
boolean
When true, reviews that include a message are returned before reviews without a message.

Response

Successful Response

Main Structure (Root)

integer
Status code returned by the API.
string
Status message that describes the API response.
array of object
Array containing review objects for the product.
boolean
Indicates whether more review data is available beyond the current page.
string | null
Cursor to fetch the next page. null when there are no more results.

data Structure (Array Of Object)

string
Unique review ID.
number
Unix timestamp in milliseconds indicating when the review was created.
string
Unique customer identifier associated with the review.
string
Review message submitted by the customer.
Payment link ID associated with the review.
string
Current review status.
number
Rating value submitted by the customer.
number
Unix timestamp in milliseconds indicating when the review was last updated.
string
Unique user ID associated with the payment link owner.
array of object
List of review images attached by the customer.
array of object
Additional review content (for example uploaded videos), each with a nested file object (id, filename, mimetype, size).
object
Customer information object (id, name).
Payment link information object (id, name, type, link, subType).