List locations

List the locations in the account, as on All Locations.

GET https://cotlet.dev/api/v1/brightlocal/locations

read

Returns each location with its ID, business name, city and whether it is Active or Ad-hoc. Results come in the order of the All Locations page. Any user of the account can read it; the reports you see follow your role.

Parameters

Parameters: list_locations
NameTypeDescription
query string string Business name or zip code to search for.
status string string Active or ad_hoc. Active locations can run scheduled reports; Ad-hoc locations run manual reports only.
cursor string string Next page cursor from the previous call.

Request

cURL
curl https://cotlet.dev/api/v1/brightlocal/locations \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("brightlocal", "list_locations")
Node.js
const result = await cotlet.call('brightlocal', 'list_locations');
CLI
cotlet call brightlocal list_locations

Example response

JSON

{
  "locations": [
    {
      "location_id": "loc_1180",
      "name": "Harbor Dental",
      "city": "Austin",
      "status": "active"
    },
    {
      "location_id": "loc_1204",
      "name": "Lakeside Dental",
      "city": "Round Rock",
      "status": "active"
    }
  ],
  "next_cursor": null
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.