REST API > Get Review Sites

Through this endpoint you can retrieve a list of the review sites associated with a location.

Request

Name Method Description
/v1/getreviewsites GET This end-point will retrieve review sites "for" a location.

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.

Sample Request

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

Response Data

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

Sample Success Message:

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