List Reviews
listReviewsList Reviews
Retrieve project reviews with facet, source, location, score, and tag filters, optional sorting by rating or timestamps, and calendar bounds on a chosen review datetime column.
List endpoints are paginated. Use the page and limit query parameters to paginate through results (at most 30 records per page). Check the pagination object in the response (current_page, last_page, total) to determine if more pages exist and whether to continue fetching.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Which page of results to return (1 is the first page). Omit this field or use 1 for the first page. Accepts minimum 1. | |
| limit | No | Maximum number of records to return. Accepts an integer from 1 to 30. | |
| score | No | Numeric rating score for the review. Accepts an integer from 1 to 5. | |
| filter | No | Review list facet aligned with console filters (non-duplicates unless duplicate is selected). | |
| date_to | No | Inclusive upper calendar date (YYYY-MM-DD) for the column chosen by date_key; must be on or after date_from when both bounds are provided. | |
| date_key | No | Review datetime column paired with date_from and date_to (defaults to created_at when omitted). | |
| sort_dir | No | Sort direction applied when sort_key is set (defaults to desc when omitted). | |
| sort_key | No | Review attribute to sort by; omit to use newest-first by creation time. | |
| tag_slug | No | URL-friendly identifier for the review tag. | |
| date_from | No | Inclusive lower calendar date (YYYY-MM-DD) for the column chosen by date_key, defaulting to created_at when date_key is omitted. | |
| source_id | No | Identifier for the source system or review platform. | |
| location_id | No | Unique numeric identifier for the location. | |
| source_slug | No | Filter reviews by source slug. | |
| source_uuid | No | Filter reviews by source UUID. | |
| location_slug | No | URL-friendly identifier for the location. | |
| location_uuid | No | Filter reviews by location UUID. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Short code or application-level status code for this resource. | |
| data | No | Response payload for the request. | |
| success | No | Indicates whether the request completed successfully. | |
| pagination | No | Pagination metadata for list responses. |