GOgoogle
accounts

GET /v1/accounts/{accountsId}/locations

Lists the locations for the specified account.

Request

  • Base URL
    https://mybusinessbusinessinformation.googleapis.com
  • Auth
    none declared

Path parameters

accountsIdstring required

Query parameters

filterstring

Optional. 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.

orderBystring

Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"

pageSizeinteger

Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.

pageTokenstring

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

readMaskstring google-fieldmask

Required. Read mask to specify what fields will be returned in the response.

Response

Successful response

nextPageTokenstring

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 ListLocations. If there are no more locations, this field is not present in the response.

totalSizeinteger

The approximate number of Locations in the list irrespective of pagination. This field will only be returned if filter is used as a query parameter.

Changes

No recorded changes to this operation across all 3 revisions of this API.