Get Several Locations
Get locations managed by the current API user. Some fields are omitted (such as paymentOptions and services). For a full list use the GET/api/locations/$id endpoint.
Query parameters
Only return locations in the business identified by businessId. Allowed multiple businessIds
Returns all locations associated with multiple business ids
Get locations in the requested cities
Possible values: REQUIRED, BASIC, ADVANCED, BONUS and COMPLETE
Get locations in the requested country
Only locations with an endDate less than or equal to endDateMax will be returned
Only locations with an endDate greater than or equal to endDateMin will be returned.
List of locationIds that should be excluded from the result
Possible values: CONNECTED, NOT_CONNECTED
Possible fieldMask options ( 'id', 'name', 'identifier', 'street', 'streetNo', 'streetAndNumber', 'addressExtra', 'zip', 'city', 'country', 'dateCreated', 'endDate', 'province', 'lat', 'lng', 'addressDisplay', 'phone', 'fax', 'timeZone', 'cellphone', 'website', 'email', 'legalIdent', 'taxNumber', 'descriptionShort', 'descriptionLong', 'imprint', 'openingHoursNotes', 'status', 'photos', 'attributes', 'lastUpdated', 'firstSyncStarted', 'lastSyncStarted', 'autoSync', 'locationSyncable', 'businessId', 'businessName', 'productPlanId', 'productPlanName', 'googleInsights', 'labels', 'customFields', 'features', 'groups', 'openingHours', 'specialOpeningHours', 'nameDescriptor', 'actionsRequired', 'profileCompleteness', 'suggestionsForFieldsAvailable', 'listingsInSync', 'activeListingsCount', 'dataPoints', 'averageRating', 'directoriesMissingConnect' )
Possible values: VERIFIED (the Google listing is verified and fully managed by us), UNVERIFIED (the Google listing is not verified), DISABLED (the Google listing is disabled), SUSPENDED (the Google listing is suspended), DUPLICATE (the Google listing is a duplicate), PENDING_VERIFICATION (a verification pin has been requested for the Google listing), NEEDS_REVERIFICATION (the verification process for the Google listing needs to be reverified), PENDING_REVIEW (there is no Google account connected for the listing)
Possible values: VERIFIED (the Google listing is verified and fully managed by us), VERIFICATION_STARTED (a verification pin has been requested for the Google listing), VERIFICATION_NOT_STARTED (the verification process has not been start for the Google listing), NOT_CONNECTED (there is no Google account connected for the listing), VERIFIED_BY_THIRD_PARTY (there is a verified listing on Google but we do not manage it)
The groupId to which the location belongs
The name of the group to which the location belongs
Only return one location (per business) based on your internal identification system
Only return locations that contain at least one of the given labels
Only return locations identified by ids listed in locationIds
Used for pagination. Maximum number of results per page. Default: 50 (Without a defined FieldMask the maximum number of results is 50.)
Only return locations that have no value for the given field
If set to true, only return locations with faulty data in need of review. Default: false.
Offset used for pagination. Default: 0
use asc for ascending sort or desc for descending sort
Get locations in the requested post / zip codes
Get locations in the requested province / state
Filter by name, zip, street, city, label
The fields that will be searched to contain the value provided in the 'query' query parameter.
Setting selectAll to true allows finding ALL locations for any given businessId, locationIds and labels. In other words these fields are OR joined.
The location property to sort by (ascending unless order is specified). One of name, street, streetNo, zip, city, phone, cellphone, fax, website, email, lastSyncStarted, country
Filter by locations status. One of ACTIVE, INACTIVE, CANCELLED
If set to true, filter locations that have been updated but did not start a sync yet
If set to true, filter locations that started a sync. If set to false, filter locations that never synced
Filter for locations that are currently set to temporarily closed (True) or are not temporarily closed (False)
Response
Locations successfully retrieved
Example response
{
"response": {
"max": 10,
"count": 100,
"locations": [
{
"addressExtra": "building, floor...",
"openingHoursNotes": "We never open on bank holidays",
"openingHours": [
{
"dayOfWeek": 1,
"closed": false,
"from1": "08:00",
"to1": "11:00"
},
{
"dayOfWeek": 2,
"closed": false,
"from1": "08:00",
"to1": "11:00",
"from2": "13:00",
"to2": "21:00"
},
{
"dayOfWeek": 3,
"closed": true
}
],
"specialOpeningHours": [
{
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": "16:00",
"to2": "20:00"
}
],
"attributes": [
{
"valueType": "BOOL, URL, ENUM, REPEATED_ENUM"
}
],
"skipFacebookPicturesUpdate": true
}
]
}
}