REST API > Get Locations

Through this endpoint you can retrieve locations for a brand or an agency.

Request

Name Method Description
/v1/getlocations GET This endpoint will retrieve a list of locations under a brand or an agency on the Online Review Manager platform.

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 string 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 string optional This is the unique identifier of a Location in your system. If you leave this field blank you will get a list of all locations. This value can be found in the location sign-up form.

Sample Request

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

Response Data

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

Sample Success Message:

{
  "status": "success",
  "message": {
    "locations": [
      {
        "location_id": "SAU1483660123",
        "location_name": "Location Name ",
        "store_phone": "(012) 345-6789",
        "address": "1830 Park Ave.",
        "city": "El Cajon",
        "state": "CA",
        "zip": "92020",
        "first_name": "David",
        "last_name": "Paak",
        "title": "Owner",
        "email": "email@example.com",
        "phone": "(012) 345-6789",
        "location_url": "example.com",
        "client_location_id": "",
        "locationStatus": "enable",
        "response_signature": {
            "negative_rate": "",
            "positive_rate": ""
        },
        "escalate_email": [],
        "location_note": "",
        "googleQA_note": "",
        "store_id": "Unique Store ID"
      }
    ]
  }
}