This API will allow you to retrieve the review sites associated with a location.

Request

Name Method Description
/v1/getreviewsites GET This end-point will retrieve review sites "for" a location 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.

Sample Request

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

Response Data

This section outlines the standard response values from a review site api

Sample Response

{
    "status": "success",
    "message": {
        "brand_name": "BrandName",
        "brand_id": 5001,
        "location_name": "LocationName",
        "location_id": "ORM1234567890",
        "industry_name": "Home Services",
        "industry_id": 1,
        "industry_review_sites": [
            {
                "reviewsite_id": 000001,
                "review_site_id": 3,
                "review_site": "Facebook",
                "send_to_api": "Y",
                "review_site_url": "https://www.facebook.com/",
                "landing_page_url": "https://www.facebook.com/",
                "username": "",
                "password": "",
                "connected": "N"
            },
            {
                "reviewsite_id": 000002,
                "review_site_id": 5,
                "review_site": "YellowPages",
                "send_to_api": "Y",
                "review_site_url": "https://www.yellowpages.com",
                "landing_page_url": "https://www.yellowpages.com",
                "username": "",
                "password": "",
                "connected": "N"
            },
            {
                "reviewsite_id": 000003,
                "review_site_id": 26,
                "review_site": "Superpages",
                "send_to_api": "N",
                "review_site_url": "https://www.superpages.com",
                "landing_page_url": "https://www.superpages.com",
                "username": "",
                "password": "",
                "connected": "N"
            }
        ]
    }
}