Reviews

This page will help you retrieve reviews with the Beambox API

Retrieve All Reviews

Use this endpoint to retrieve all your reviews. By default, the response will be limited to 100 notifications, you can include the limit and offset variables to make multiple requests if you have over 100 notifications.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

Ruby

HTTParty.get("https://beambox.com/api/v1/YOUR_API_KEY_HERE/reviews", body: {limit: 2, offset: 0})

Response

[
    {
        "id": 57193,
        "review_page": "Beambox",
        "location": "Location 2",
        "name": "Jaymin Patel",
        "date": "Monday 09 November 2020",
        "rating": 3,
        "review_text": "Testing worker",
        "human": "Jaymin Patel"
    },
    {
        "id": 56449,
        "review_page": "Google",
        "location": "Location 2",
        "name": "Kelly Hansen",
        "date": "Sunday 13 October 2019",
        "rating": 5,
        "review_text": "This place has great food and drinks lots to choose from and the prices are good. They do have a happy hour check that out.",
        "human": ""
    }
]

Retrieve A Review

Use this endpoint to retrieve the details of a single review. The review ID is a required parameter.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

Replace REVIEW_ID_HERE with the ID of the notification you want to retrieve.

Ruby

HTTParty.get("https://beambox.com/api/v1/YOUR_API_KEY_HERE/review/REVIEW_ID_HERE")

Response

{
    "id": 57193,
    "review_page": "Beambox",
    "location": "Location 2",
    "name": "Jaymin Patel",
    "date": "Monday 09 November 2020",
    "rating": 3,
    "review_text": "Testing worker",
    "human": "Jaymin Patel"
}