Docs
Sites APIProperties

Reviews

Published reviews, newest first. `meta.rating` carries the property's overall average and count. Sort keys: `date`, `rating`. Tag: `property:{id}`.

GET/api/sites/v1/properties/{property}/reviews

Published reviews, newest first. meta.rating carries the property's overall average and count. Sort keys: date, rating. Tag: property:{id}.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Path Parameters

property*string

The property's slug. UUIDs are not accepted.

Query Parameters

source?string

Review sources, comma-separated.

rating?

rating[gte]=4. Operators: gte, lte, gt, lt.

sort?string

Sort key, - prefix for descending, comma-separated for several. Allowed keys are listed per endpoint.

page?integer
Range1 <= value
Default1
per_page?integer
Range1 <= value <= 100
Default20

Header Parameters

X-Resi-Website?string

Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.

If-None-Match?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sites/v1/properties/string/reviews"
{  "data": [    {      "id": "string",      "source": "string",      "reviewer_name": "string",      "reviewer_photo_url": "string",      "text": "string",      "rating": 0,      "reviewed_at": "string",      "reply": {        "text": "string",        "replied_at": "string"      }    }  ],  "meta": {    "rating": {      "average": 0,      "count": 0    },    "pagination": {      "total": 0,      "page": 0,      "per_page": 0,      "last_page": 0    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}