Through this API you can retrieve responses to reviews for your locations that are signed up for the Response Scribe service.

Request

Name Method Description
/v1/getresponse GET This end-point will retrieve a response "for" a review from the Online Review Manager Portal.

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to you when the Agency was created.
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. If you have created the identical client_location_id for another location under your agency then this parameter becomes "required".
client_brand_id string required/optional This is the unique identifier of a Brand in your system.
location_id integer required/optional This is the unique identifier of the Location in our system.
client_location_id integer required/optional This is the unique identifier of the Location in your system.
show_all boolean optional Should we return ALL responses? Including those that have already been sent(Y)? Default: N
mark_response_retrieve string optional If you want to response mark as retrieve then put Y otherwise put N. Default value would be Y.
review_id integer optional If you want to get response by review id.

Sample Request

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

Response Data

This section outlines the standard response values from a response api

Sample Response

{
  "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
      }
    ]
  }
}