REST API > Get Response

Through this endpoint you can retrieve review responses that were posted on or are hosted on the Online Review Manager platform.

Request

Name Method Description
/v1/getresponse GET Through this end-point you can retrieve a review "response".

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to your agency. This key can be found in your agency settings under the White Label API information tile.
brand_id integer required/optional This is the unique identifier of a Brand in our system. It was automatically created when you created the Brand. The brand id can be found in your account settings under the account information tile.
client_brand_id string required/optional This is the unique identifier of a Brand in your system. This value can be found in the brand sign-up form.
location_id integer required/optional This is the unique identifier of a Location in our system. It was automatically created when you created the Location. If you leave this field blank you will get a list of all Locations. The location id can be found in the brand settings under the location sign-up form.
client_location_id integer required/optional This is the unique identifier of the Location in your system. This value can be found in the location sign-up form.
show_all boolean optional If you would like all responses, including those that have already been sent, then enter Y. Default is set to N.
mark_response_retrieve string optional If you would like the response marked as retrieved then enter Y, otherwise enter N. Default value is set to Y.
review_id integer optional If you would like to receive a response based on the review id, enter the review id. This is the unique identification assigned to a review in the Online Review Manager platform. This unique review_id can be received using the Get Reviews endpoint.

Sample Request

GET : https://api.online-review-manager.com/v1/getresponse

Response Data

You will recieve a success or error message. See sample success message below:

Sample Success Message:

{
    "status": "success",
    "message": {
        "responses": [
            {
                "review_id": "5001",
                "response_text": "This is response example text.",
                "responder": "David",
                "response_date": "2017-01-10",
                "response_sent":0
            },
            {
                "review_id": "5002",
                "response_text": "This is response example text.",
                "responder": "John Doe",
                "response_date": "2017-01-01",
                "response_sent":1
            }
        ]
    }
}