Skip to main content
Endpoint:

Authorization

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

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.
string
Filter reviews by status (for example ACTIVE, ARCHIVED, or INACTIVE).
Filter reviews belonging to a specific payment link / product.
number
Filter reviews by rating value (1–5).

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.
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.
number
Rating value submitted by the customer.
string
Current review status.
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.
string
Unique image ID.
string
File extension of the image (for example png or jpg).
string | null
Optional description of the image.
string
Public URL of the image.
array of object
Additional review content (for example uploaded videos).
string
Unique content entry ID.
string
Identifier of the underlying file referenced by this content entry.
object
File metadata for this content entry.
string
Unique file ID.
string
Original file name.
number
File size in bytes.
string
MIME type of the file (for example video/mp4).
object
Customer information object.
string
Unique customer ID.
string
Customer full name.
Payment link information object.
Unique payment link ID.
Name of the payment link or product.
Type of payment link or product.
Slug or public link identifier of the payment link.
Additional subtype information of the payment link.