Method: accounts.locations.list

Lists the locations for the specified account.

HTTP request

GET https://mybusiness.googleapis.com/v3/{name=accounts/*}/locations

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

The name of the account to fetch locations from.

Query parameters

Parameters
pageSize

number

How many locations to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.

pageToken

string

If specified, it fetches the next page of locations. The page token is returned by previous calls to locations.list when there were more locations than could fit in the requested page size.

filter

string

A filter constraining the locations to return. The response includes only entries that match the filter. If filter is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account.

For more information about valid fields and example usage, see Work with Location Data Guide

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "locations": [
    {
      object(Location)
    }
  ],
  "nextPageToken": string
}
Fields
locations[]

object(Location)

The locations

nextPageToken

string

If the number of locations exceeded the requested page size, this field is populated with a token to fetch the next page of locations on a subsequent call to locations.list. If there are no more locations, this field is not present in the response.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/plus.business.manage

For more information, see the Auth Guide.

Send feedback about...

Google My Business API
Google My Business API
Need help? Visit our support page.