Authorization
Example:
Authorization | Bearer Paste-Your-Api-Key-HereQuery Parameters
Maximum number of reviews to return per page. Used for cursor pagination.
Cursor for the next page. Pass the
nextStartingAfter value from the previous response.Filter reviews by status (for example
ACTIVE, ARCHIVED, or INACTIVE).Filter reviews belonging to a specific payment link / product.
Filter reviews by rating value (1–5).
Response
Successful ResponseMain Structure (Root)
Status code returned by the API.
Status message that describes the API response.
Array containing review objects.
Indicates whether more review data is available beyond the current page.
Cursor to fetch the next page.
null when there are no more results.data Structure (Array Of Object)
Unique review ID.
Unix timestamp in milliseconds indicating when the review was created.
Unique customer identifier associated with the review.
Review message submitted by the customer.
Payment link ID associated with the review.
Rating value submitted by the customer.
Current review status.
Unix timestamp in milliseconds indicating when the review was last updated.
Unique user ID associated with the payment link owner.
List of review images attached by the customer.
Unique image ID.
File extension of the image (for example
png or jpg).Optional description of the image.
Public URL of the image.
Additional review content (for example uploaded videos).
Unique content entry ID.
Identifier of the underlying file referenced by this content entry.
File metadata for this content entry.
Unique file ID.
Original file name.
File size in bytes.
MIME type of the file (for example
video/mp4).Customer information object.
Unique customer ID.
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.
