PHphorest
Review

List reviews

Get a list of reviews for the specified business id and branch id. List can be filtered by client id, client's first name or surname, staff member's first name or surname and date of review

get/api/business/{businessId}/branch/{branchId}/review

Request

Path parameters

businessIdstring required
branchIdstring required

Query parameters

clientIdstring

Client id to filter by

clientNamestring

Client first name or surname to filter by

staffNamestring

Staff member first name or surname to filter by

reviewDatestring

Date of review to filter by. yyyy-MM-dd

number of review records to return, max is 200

page number, default is 0 and is optional

Response

Reviews listed

Example response

{
  "_embedded": {
    "reviews": [
      {
        "reviewId": "r12434",
        "clientId": "ab123",
        "clientFirstName": "John",
        "clientLastName": "Doe",
        "reviewDate": "2017-01-19",
        "visitDate": "2020-10-23",
        "staffId": "xyz321",
        "staffFirstName": "Joe",
        "staffLastName": "Bloggs",
        "text": "Great Service",
        "rating": 5,
        "facebookReview": true
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.