v1Resources/Locations/getList location groups

List location groups

A location group is a set of locations listed together as one brand. On directories that support it (Localtunity today, and the regional sites that copy it), the group is one business named after the group, and each location appears under it with its own address. Every other directory keeps listing each location on its own. Use it for a chain, most often when its locations share a phone number, because those directories accept only one listing per number. Returns each group the key can see, plus `sites`: the directories that list groups together. With a key limited to some clients, counts and client ids cover only those clients; `hiddenLocationCount` counts the rest.

get/api/v1/location-groups
locations:read
Query parameters
locationIdstringoptional
Return only the group this location is in (location id or public id).
Response
dataobjectoptional
groupsarray of objectoptional
idstringoptional
namestringoptional
The business name the locations appear under on the directories that list the group.
locationCountintegeroptional
Locations in the group that the key can see.
clientIdsarray of stringoptional
Clients of those locations.
hiddenLocationCountintegeroptional
Locations in the group belonging to clients the key cannot access.
createdAtstringoptional
sitesarray of objectoptional
Directories that list groups together.
siteIdintegeroptional
namestringoptional
copiesarray of objectoptional
Regional sites that republish this directory's listings.
siteIdintegeroptional
namestringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/location-groups
Your API key
locationId
{}

Guides that use this resource