NodeRings Docs

List Provider Reviews

GET
/v1/provider-reviews
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Query Parameters

page?integer
Formatint32
pageSize?integer
Formatint32
starRatings?array<integer>

Multi-select star filter (e.g. [5,4]); empty means any stars.

search?string

Case-insensitive substring match on review comment or provider reply; empty means no text filter.

replyFilter?integer

Inbox: 0 = awaiting provider reply / empty reply (default), 1 = replied only, 2 = all reviews.

Formatint32

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/provider-reviews?page&pageSize&starRatings&search&replyFilter" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "reviews": [
    {
      "id": "string",
      "starRating": 0,
      "comment": "string",
      "providerReply": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z",
      "providerRepliedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalCount": 0,
  "providerTotalReviews": 0,
  "providerAverageStar": 0.1,
  "providerStarSummary": [
    {
      "starRating": 0,
      "reviewCount": 0
    }
  ]
}