List reviews
List reviews contextual to the caller.
- Customers see their own reviews
- Barbers see reviews for their appointments
- Admins see all reviews
Query Parameters
Filter reviews by state. When included, only reviews with any of these states are returned. When excluded, reviews are not filtered by state.
The state of a review.
pending, approved, rejected Filter reviews by sentiment. When included, only reviews with any of these sentiments are returned. When excluded, reviews are not filtered by sentiment.
The sentiment of a review.
positive, negative Filter reviews by date range.
A date range, supporting inclusive or exclusive endpoints.
Dates ranges use dates expressed in YYYY-MM-DD RFC 3339
date format.
The value may have the following forms:
YYYY-MM-DDmatch the date exactly; equivalent to matching dates in the range[YYYY-MM-DD,YYYY-MM-DD][YYYY-MM-DD,YYYY-MM-DD]between two dates, inclusive of the endpoints(YYYY-MM-DD,YYYY-MM-DD)between two dates, exclusive of the endpoints[YYYY-MM-DD,]on or after the date(YYYY-MM-DD,)after the date[,YYYY-MM-DD]before or on the date(,YYYY-MM-DD)before the date
Examples:
- '2022-05-19'
- '[2022-05-01,2022-05-31]'
- '[2022-05-01,2022-06-01)'
- '[2022-05-19,]'
- '(2022-05-19,)'
- '[,2022-05-19]'
- '(,2022-05-19)'
24(?:^(\d{4}-\d{2}-\d{2}|([\[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]]))$)The offset for pagination. Defaults to 0.
x >= 0The maximum number of results to return. Defaults to 50.
1 <= x <= 250Response
Ok. The operation succeeded.