Review

Find a review by ID

get/api/v1/restaurants/{restaurant_id}/reviews/{review_id}

Request

  • Base URL: https://gotable.app
  • URL: https://gotable.app/api/v1/restaurants/{restaurant_id}/reviews/{review_id}
  • Auth: HTTP bearer

Path parameters

restaurant_idinteger required
review_idinteger required

Response

With a valid API token

idinteger

The unique ID of the review

restaurant_idinteger

The unique ID of the restaurant the review was left for

reservation_idinteger

The unique ID of the reservation the review followed

guest_idinteger nullable

The unique ID of the guest who left the review, when it could be linked to one

author_namestring

The name the review was signed with

author_emailstring

The email address the review was left with

ratinginteger nullable

The rating the guest gave, from 1 to 10. Reviews without a rating are text only.

descriptionstring

What the guest wrote

state'unchecked' | 'approved'

Whether the restaurant has accepted the review yet. Rejected reviews are not returned.

created_atstring date-time

When the review was left

updated_atstring date-time

When the review was last changed

Example response

{
  "id": 98765,
  "restaurant_id": 12345,
  "reservation_id": 54321,
  "guest_id": 24680,
  "author_name": "John Doe",
  "author_email": "john.doe@example.com",
  "rating": 8,
  "description": "Lovely evening, the sea bass was excellent.",
  "state": "unchecked",
  "links": [
    {
      "url": "https://gotable.app/api/v1/restaurants/12345/reviews/98765",
      "rel": "self",
      "method": "GET"
    },
    {
      "url": "https://gotable.app/api/v1/restaurants/12345",
      "rel": "restaurant",
      "method": "GET"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.